Make setup.py build the docs

Bug #829827 reported by Jason Gerard DeRose
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
FileStore
Fix Released
High
Jason Gerard DeRose

Bug Description

Not sure exactly what the best practice is here, but probably looking at the way bzr does it would be a good place to start.

I believe this will require a custom distutils command, similar to the Test command we already have. There are two approaches you can take to building the docs. From the source tree root, you can run:

  sphinx-build -b html doc/ doc/_build/

Or from doc/ you can run:

  make html

The first is probably better as it should work fine on Windows also. We want our daily builds and stable releases to build the docs using setup.py, and we'll add a `python3-filestore-doc` package.

Tags: bitesize

Related branches

Changed in filestore:
assignee: nobody → Jason Gerard DeRose (jderose)
status: Triaged → In Progress
Changed in filestore:
status: In Progress → Fix Committed
Changed in filestore:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.