search

DaveStrickland / AstroPhotography

Python workflow for processing astrophotography images from either digital cameras and/or amateur telescopes.
GNU General Public License v3.0
19 stars 3 forks source link

Sphinx documentation generation does not work #15

Closed DaveStrickland closed 1 year ago

DaveStrickland commented 2 years ago

Attempting to generate the sphinx documentation fails.

The may be a configuration issue and/or a code documentation style issue.

We need to pick a format of code documatation that works (preferably astropy, or maybe numpy), convert all doc strings to it, and get the documentation working.

DaveStrickland commented 2 years ago

Actively working this issue now.

DaveStrickland commented 1 year ago

After a big pause, I've finally gotten around to working on this.

It requires some reorganization of the package. To build the documentation:

#git pull origin
cd doc
make html
# documentation index file will be in $(pwd)/_build/html/index.html
DaveStrickland commented 1 year ago

Resolved by bad2479