|
1 | | -# Generate Documentation Script |
| 1 | +# Generate Documentation |
2 | 2 |
|
3 | | -The [`generate_docs()`](generate_docs.py) script generates or updates a number of markdown pages for the documentation website, as well as some files for the [OpenAD Toolkit] repository, ensuring consistency across all documentation. |
| 3 | +This script generates and updates a number of markdown pages for the documentation website, as well as some files for the [openad-toolkit] repository, ensuring consistency across all documentation. |
| 4 | + |
| 5 | +<br> |
4 | 6 |
|
5 | 7 | ### How to regenerate documentation |
6 | 8 |
|
7 | | -Export all files into the [_output](_output) folder. More details for each script can be found in the docstrings. |
| 9 | +Generate all files → save to [/_output](_output) |
| 10 | +More details for each script can be found in the docstrings. |
8 | 11 |
|
9 | 12 | ``` |
10 | 13 | python3 generator/generate_docs.py |
@@ -34,12 +37,12 @@ Documentation pages generated by script: |
34 | 37 | Documentation pages with descriptions that are updated by script: |
35 | 38 | - [OpenAD Plugins](https://openad.accelerate.science/docs/plugins) |
36 | 39 |
|
37 | | -Files Updated for the [OpenAD Toolkit] repo: |
38 | | -- [README.md](https://github.com/acceleratedscience/openad-toolkit?tab=readme-ov-file#readme) for the openad-toolkit repo |
39 | | -- |
| 40 | +Files generated or updated for the [openad-toolkit] repo: |
| 41 | +- [README.md](https://github.com/acceleratedscience/openad-toolkit?tab=readme-ov-file#readme) |
| 42 | +- [concepts.py](https://github.com/acceleratedscience/openad-toolkit/blob/main/openad/helpers/concepts.py) |
40 | 43 |
|
41 | | -Other files that are generated or updated by the script: |
42 | | -- [commands.csv](generator/_output/other/commands.csv) overview file |
| 44 | +Other files: |
| 45 | +- [commands.csv](generator/_output/other/commands.csv) overview file (not used, for record only) |
43 | 46 |
|
44 | 47 |
|
45 | 48 | ### What this does |
@@ -164,4 +167,4 @@ Other files that are generated or updated by the script: |
164 | 167 |
|
165 | 168 |
|
166 | 169 |
|
167 | | -[OpenAD Toolkit]: https://github.com/acceleratedscience/openad-toolkit |
| 170 | +[openad-toolkit]: https://github.com/acceleratedscience/openad-toolkit |
0 commit comments