zec
/
simtfl
mirror of https://github.com/zcash/simtfl.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add `apidoc/` to `.gitignore` and clarify README on generating docs. 

Signed-off-by: Daira Emma Hopwood <daira@jacaranda.org>
This commit is contained in:
Daira Emma Hopwood 2023-10-20 21:09:18 +01:00
parent 70c9ee523d
commit de53ac847c
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -1,6 +1,9 @@
*.swp
*.save
# API docs
apidoc/
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]

5
README.md
View File

@ -29,8 +29,9 @@ Design documentation is under the `doc/` directory:
* [Programming patterns for use of simpy](doc/patterns.md).
You can also generate API documentation by running `./gendoc.sh`.
The starting point for the generated documentation is <apidoc/simtfl.html>.
You can also generate API documentation by running `./gendoc.sh`. This assumes
that you have run `poetry install` as shown above. The starting point for the
generated documentation is <apidoc/simtfl.html>.
## Contributing