Skip to content

Commit a02b528

Browse files
committed
Update readme
1 parent 5788a41 commit a02b528

1 file changed

Lines changed: 12 additions & 9 deletions

File tree

generator/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
# Generate Documentation Script
1+
# Generate Documentation
22

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>
46

57
### How to regenerate documentation
68

7-
Export all files into the [_output](_output) folder. More details for each script can be found in the docstrings.
9+
Generate all files &rarr; save to [/_output](_output)
10+
More details for each script can be found in the docstrings.
811

912
```
1013
python3 generator/generate_docs.py
@@ -34,12 +37,12 @@ Documentation pages generated by script:
3437
Documentation pages with descriptions that are updated by script:
3538
- [OpenAD Plugins](https://openad.accelerate.science/docs/plugins)
3639

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)
4043

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)
4346

4447

4548
### What this does
@@ -164,4 +167,4 @@ Other files that are generated or updated by the script:
164167

165168

166169

167-
[OpenAD Toolkit]: https://github.com/acceleratedscience/openad-toolkit
170+
[openad-toolkit]: https://github.com/acceleratedscience/openad-toolkit

0 commit comments

Comments
 (0)