Open Stack

On 09/08/2014 11:59 AM, Joshua Harlow wrote:
> Hi all,
>
> I just wanted to get some feedback on a change that I think will make the docs building process more understood,
>
> Currently there is a script @ https://github.com/openstack-infra/config/blob/master/modules/openstack_project/files/slave_scripts/run-docs.sh (this is the github mirror fyi) that builds your docs when requested using an implicit virtualenv 'venv' with a single command `tox -e$venv -- python setup.py build_sphinx`. Over the weekend I was working on having the taskflow 'docs' venv build a changelog and include it in the docs when I learned that the 'docs' virtualenv isn't actually what is called when docs are being built (and thus can't do customized things to include the changelog).
>
> I wanted to get some some feedback on standardizing around the 'docs' virtualenv for docs building (it seems common to use this in most projects anyway) and depreciate or remove the implicitly used 'venv' + above command to build the docs and just have the infra setup call into the 'docs' virtualenv and have it build the docs as appropriate for the project.
>
> This would mean that all projects would at least need the following in there tox.ini (if they don't already have it).
>
> [docs]
> commands = python setup.py build_sphinx
>
> Does this seem reasonable to all?
>
> There is also a change in the governance repo for this as well @ https://review.openstack.org/#/c/119875/
>
> Thoughts, comments, other?

For those who like numbers, across all of the repos in gerrit that have 
docs dirs, 11 need to have a doc env renamed to docs, and 9 need one 
added - all of the rest of the repos, including every integrated repo, 
has a docs env already.