10 Commits

Author SHA1 Message Date
Thomas Goirand
393ecedc3b Make the doc build reproducible
This fixes Debian bug:
https://bugs.debian.org/826676

Change-Id: I638488448a4d6e644ab0e6deaebd65c92fa7904a
2016-07-11 14:55:12 +02:00
Steve Martinelli
727792da17 autodocument commands from plugins using stevedore.sphinxext
conflicting command names are a painpoint, so is manually updating
a list. let's autodocument the commands that are being use by
existing osc supporters.

Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-12-01 01:23:56 -05:00
lin-hua-cheng
89cf9f61b1 Fixes modules index generated by Sphinx
Sphinx was always using (o)penstackclient for the prefix so the index
wasn't very useful.

Change-Id: Ie9f5d7fe428142bdb8027b422e3023418b48c428
2015-07-09 21:40:31 -07:00
Steve Martinelli
6dc128636e Enhance the theming for modules page
Also fixes a few small docstring syntax errors

Change-Id: I85eb968e32c1191cf5d60d02deff2ab7f3291074
2014-11-18 22:07:57 -05:00
Andreas Jaeger
c5df1826a6 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-13 09:46:09 +02:00
Steve Martinelli
b5001e4b21 Use oslosphinx to generate documentation
Rather than host different and possibly out of date versions of
static and theme files, use oslosphinx to generate the docs.

Change-Id: I7eadc8e40aa10cc26cfd6aece6efa5d13fee70b0
2014-08-05 01:31:20 -04:00
Steve Martinelli
deaff7274e Update docs template
To make things more consistent across all openstack projects, the
developer docs should be upgraded to the newer template used by
keystone and keystoneclient (and other projects).

I dropped in the necessary static files and themes, and updated
the config file to make the changes at build time.

Change-Id: I5a268cff3cd5af29ad712705d540b9d1d6667d56
Partial-Bug: #1331304
2014-06-18 03:47:37 +00:00
Dean Troyer
6f9dcc13f6 Prep for 0.2 release (0.2.rc1)
* rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file
* add the barest of pointers to the wiki, etc. to the source docs
* add a bare-bones man page

Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe
2013-08-01 16:21:22 -05:00
lrqrun
2372142eaa Fix PEP8 issues.
Fix some pep8 issues in doc/source/conf.py and tests/test_shell.py  make the code looks pretty.

Change-Id: I927f03aff4190f1ac30eb56e7c545de555978c31
2012-08-29 14:17:08 +08:00
Clark Boylan
77e5ce57fd Move docs to doc.
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc/source and build results go in project/doc/build.

Change-Id: I925e687254bac9e06c2c520f4fc35a083e21c4ca
2012-06-11 14:37:48 -07:00