forked/osxphotos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
dc4d322dab03139eee522a97e2b2de8900d1360e
osxphotos/docsrc
History
Rhet Turnbull dc4d322dab Feature timewarp (#675) 
* Implemented timewarp command

* Updated docs

* Added missing pytest mark
2022-05-01 10:01:05 -07:00
..
source
Feature timewarp (#675)
2022-05-01 10:01:05 -07:00
make.bat
Fixed docs [skip ci]
2021-01-24 17:35:49 -08:00
Makefile
Added docs
2022-04-19 09:40:08 -07:00
README.md
Updated docs build to use cog
2022-04-23 08:16:47 -07:00

README.md

Building the documentation

I'm still trying to learn sphinx and come up with a workflow for building docs. Right now it's pretty kludgy.

  • python3 -m pip -r dev_requirements.txt
  • Download and install 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
Reference in New Issue View Git Blame Copy Permalink