You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
And then navigate to [`http://0.0.0.0:8000`](http://0.0.0.0:8000) on your local
22
22
machine.
23
23
24
+
## Sub-package Documentation
25
+
26
+
When adding documentation for a new sub-package, ensure it is properly integrated into the documentation site by:
27
+
28
+
1. Adding an entry to `docs/docs/user-guide/examples/SUMMARY.md` to include it in the Tutorials section
29
+
2. Adding an entry to `docs/docs/user-guide/developer-guide/SUMMARY.md` to include it in the Developer Guide section
30
+
31
+
This ensures the sub-package documentation is properly indexed and accessible through the navigation menu.
32
+
33
+
The sub-package specific documentation itself must be placed alongside the sub-package code in the `sub-packages/bionemo-<sub-package-name>/` directory:
34
+
35
+
-`README.md` - A root level file that describes the sub-package and how to use it.
36
+
-`examples/` - A directory that contains documentation or examples specific to the sub-package, in the form of `.md` or `.ipynb` files.
37
+
-`assets/` - A folder that contains any static assets used in any of the above files, e.g. `.png` files.
38
+
39
+
When the docs are built, these documentation files will be fetched (via the [scripts/gen_ref_pages.py](./scripts/gen_ref_pages.py) script) for rendering in the main documentation site.
40
+
41
+
- The `README.md` will be rendered as an individual page in the `User Guide -> Developer Guide -> <sub-package-name>/` section of the documentation site.
42
+
- Every file in the `examples/` directory will be rendered as an individual page in the `User Guide -> Tutorials -> <sub-package-name>/` section of the documentation site.
43
+
44
+
An example sub-package structure is shown below:
45
+
46
+
```
47
+
bionemo-<sub-package-name>/
48
+
└── assets/
49
+
├── example_1.png
50
+
├── examples/
51
+
│ ├── example_1.md
52
+
│ └── example_2.ipynb
53
+
├── src/
54
+
├── tests/
55
+
├── LICENSE
56
+
├── pyproject.toml
57
+
├── README.md
58
+
├── VERSION
59
+
```
60
+
24
61
## Hiding/collapsing `.ipynb` cells
62
+
25
63
To remove cells from the rendered `mkdocs` html you can add a `remove-cell` tag to the cell. Note that `remove-output` is also an option to hide outputs but not the code cell. Unfortunately
0 commit comments