rowan.a.tl/propeller
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated documentation

Browse Source
This commit is contained in:
Ashley Bao 2023-03-28 09:02:28 -04:00
parent 0df7e26621
commit 341a5820ab
3 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/Generating_Documentation.html
View File

File diff suppressed because one or more lines are too long

1
scripts/GenerateDocs.sh Normal file → Executable file
View File

@ -1,5 +1,6 @@
#!/bin/sh
pip install mdutils
lein codox
python3 FunctionsToMD.py
python3 HTMLFix.py

5
src/docs_src/Generating_Documentation.md
View File

@ -1,6 +1,9 @@
# Generating Documentation for Propeller
To generate documentation with [codox](https://github.com/weavejester/codox), run `scripts/GenerateDocs.sh`in the command line.
In order to generate documentation, you'll need Python and `pip` installed.
To generate documentation with [codox](https://github.com/weavejester/codox), run `scripts/GenerateDocs.sh`in the command line from the `scripts` directory.
To make the script executable, you may need to first run `chmod +x GenerateDocs.sh`.
This will run "lein codox" on the command line to generate first batch of HTMl files.
Then, it runs FunctionsToMD to take Push instructions generated by `def-instruction` and spit it out to a Markdown file.
Then, it runs HTMLFix to fix the ordered lists in `Adding_Genetic_Operators.md`, `Adding_Problem.md`, and