This site is an archive; learn more about 8 years of OpenHatch.

[OH-Dev] [issue895] Update docs to explain how to "build" documentation (and explain how readthedocs integration works)

Asheesh Laroia bugs at openhatch.org
Tue Nov 5 22:28:50 UTC 2013


New submission from Asheesh Laroia <asheesh at asheesh.org>:

Right now, at 
http://openhatch.readthedocs.org/en/latest/contributor/documentation.html , I 
would change the following things:

* It uses the term "deploying" where it really (IMHO) means "building", and 
doesn't vividly explain that this is about "building the HTML version of the 
documentation" as well as validating that the use of Sphinx is valid.

* It doesn't explain how openhatch.readthedocs.org is updated. It should do 
that.

(The way it works is a github web hook, and it updates from master.)

----------
messages: 3925
nosy: paulproteus
priority: bug
status: unread
title: Update docs to explain how to "build" documentation (and explain how readthedocs integration works)

__________________________________________
Roundup issue tracker <bugs at openhatch.org>
<https://openhatch.org/bugs/issue895>
__________________________________________


More information about the Devel mailing list