Skip to content

Commit a87f364

Browse files
authored
Merge: Fix Minor Docs Issues (emdgroup#741)
Fixes emdgroup#727 and emdgroup#578 Changed - added a html anchor to the README, this makes the link clickable on GitHub and has no influence on the deployed page (is not visible there) - Update build script to not do linebreaks if they are on commented files On my fork this has fixed the issues: - [README link](https://github.com/Scienfitz/baybe-dev) is clickable - [deployed link](https://scienfitz.github.io/baybe-dev/latest/index.html#quick-start) is clickable - [Exemplary title length issue](https://scienfitz.github.io/baybe-dev/latest/examples/Backtesting/impute_mode.html) is fixed It does not remove the visible `(installation)=` from the README but since there is no net loss this solution should be accepted as Issue closing.
2 parents a1a54f2 + 528870c commit a87f364

2 files changed

Lines changed: 6 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,7 @@ optimization (from [Shields, B.J. et al.](https://doi.org/10.1038/s41586-021-032
234234
chemical encodings compared to one-hot and a random baseline:
235235
![Substance Encoding Example](./examples/Backtesting/full_lookup_light.svg)
236236

237+
<a id="installation"></a>
237238
(installation)=
238239
## 💻 Installation
239240
### From Package Index

docs/scripts/build_examples.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,11 @@ def build_examples(destination_directory: Path, dummy: bool, remove_dir: bool):
158158
continue
159159
if any(substring in line for substring in ignored_substrings):
160160
continue
161-
if len(line) > 88 and "](" not in line:
161+
if (
162+
len(line) > 88
163+
and "](" not in line
164+
and not line.lstrip().startswith("#")
165+
):
162166
wrapped = textwrap.wrap(line, width=88)
163167
wrapped_lines.extend(wrapped)
164168
else:

0 commit comments

Comments
 (0)