Skip to content

Commit 77e5ce5

Browse files
cboylancboylan
committed
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
1 parent 64f685a commit 77e5ce5

6 files changed

Lines changed: 6 additions & 6 deletions

File tree

‎MANIFEST.in‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
include AUTHORS
22
include LICENSE
33
include README.rst
4-
recursive-include docs *
4+
recursive-include doc *
55
recursive-include tests *

‎README.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Building Contributor Documentation
101101

102102
This documentation is written by contributors, for contributors.
103103

104-
The source is maintained in the ``docs/source`` folder using
104+
The source is maintained in the ``doc/source`` folder using
105105
`reStructuredText`_ and built by `Sphinx`_
106106

107107
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
@@ -115,7 +115,7 @@ The source is maintained in the ``docs/source`` folder using
115115

116116
$ export DJANGO_SETTINGS_MODULE=local.local_settings
117117
$ python doc/generate_autodoc_index.py
118-
$ sphinx-build -b html docs/source build/sphinx/html
118+
$ sphinx-build -b html doc/source build/sphinx/html
119119

120120
Results are in the `build/sphinx/html` directory
121121

docs/Makefile renamed to doc/Makefile

File renamed without changes.

docs/source/conf.py renamed to doc/source/conf.py

File renamed without changes.

docs/source/index.rst renamed to doc/source/index.rst

File renamed without changes.

‎setup.cfg‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ verbosity=2
77
detailed-errors=1
88

99
[build_sphinx]
10-
source-dir = docs/
11-
build-dir = docs/_build
10+
source-dir = doc/source
11+
build-dir = doc/build
1212
all_files = 1
1313

1414
[upload_sphinx]
15-
upload-dir = docs/_build/html
15+
upload-dir = doc/build/html

0 commit comments

Comments
 (0)