Updated docs build to use cog

This commit is contained in:
Rhet Turnbull
2022-04-23 08:16:47 -07:00
parent ee6e4602e4
commit b8b4c15784
60 changed files with 561 additions and 433 deletions

View File

@@ -2,12 +2,17 @@
I'm still trying to learn sphinx and come up with a workflow for building docs. Right now it's pretty kludgy.
- `pip install sphinx`
- `pip install sphinx-rtd-theme`
- `pip install m2r2`
- `python3 -m pip -r dev_requirements.txt`
- Download and install [MacTeX](https://tug.org/mactex/)
- Add `/Library/TeX/texbin` to your `$PATH`
- `cd docs`
- `make html`
- `make latexpdf`
- `cp _build/latex/osxphotos.pdf .`
The `build.sh` script in the main repo directory will build the documents for you and is the preferred way to build the docs.
The following files are generated by `build.sh` and should not be directly edited:
- source/template_help.rst
- source/tutorial.rst