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 and build results go in project/doc/build. Change-Id: Ic523a716e4113198b777d6dc3db8bb8a729e7696
This commit is contained in:
parent
f9d38741dd
commit
f1a8e0c54f
.gitignoreMANIFEST.inREADME.rst
doc
Makefile
run_tests.shsetup.cfgsource
_static
.gitignorebasic.cssdefault.cssheader-line.gifheader_bg.jpgjquery.tweet.jsopenstack_logo.pngtweaks.css
_templates
_theme
conf.pycontributing.rstfaq.rstglossary.rstindex.rstintro.rstquickstart.rstref
context_processors.rstdecorators.rstexceptions.rstforms.rsthorizon.rstmiddleware.rstrun_tests.rsttables.rsttabs.rsttest.rstusers.rstviews.rstworkflows.rst
releases
testing.rsttopics
4
.gitignore
vendored
4
.gitignore
vendored
@ -12,8 +12,8 @@ pylint.txt
|
||||
reports
|
||||
horizon.egg-info
|
||||
openstack_dashboard/local/local_settings.py
|
||||
docs/build/
|
||||
docs/source/sourcecode
|
||||
doc/build/
|
||||
doc/source/sourcecode
|
||||
/static/
|
||||
.venv
|
||||
.tox
|
||||
|
@ -1,4 +1,4 @@
|
||||
recursive-include docs *.py *.rst *.css *.js *.html *.conf *.jpg *.gif *.png *.css_t
|
||||
recursive-include doc *.py *.rst *.css *.js *.html *.conf *.jpg *.gif *.png *.css_t
|
||||
recursive-include horizon *.html *.css *.js *.csv *.template *.tmpl *.mo *.po
|
||||
recursive-include openstack_dashboard *.html *.js *.css *.less *.csv *.template *.mo *.po *.example *.eot *.svg *.ttf *.woff *.png *.gif *.ico *.wsgi
|
||||
recursive-include tools *.py *.sh
|
||||
@ -10,8 +10,8 @@ include Makefile
|
||||
include manage.py
|
||||
include README.rst
|
||||
include run_tests.sh
|
||||
include docs/Makefile
|
||||
include docs/source/_templates/.placeholder
|
||||
include doc/Makefile
|
||||
include doc/source/_templates/.placeholder
|
||||
include tools/pip-requires
|
||||
include tools/test-requires
|
||||
|
||||
|
@ -106,7 +106,7 @@ Building Contributor Documentation
|
||||
|
||||
This documentation is written by contributors, for contributors.
|
||||
|
||||
The source is maintained in the ``docs/source`` folder using
|
||||
The source is maintained in the ``doc/source`` folder using
|
||||
`reStructuredText`_ and built by `Sphinx`_
|
||||
|
||||
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
|
||||
|
Before ![]() (image error) Size: 48 B After ![]() (image error) Size: 48 B ![]() ![]() |
Before ![]() (image error) Size: 3.7 KiB After ![]() (image error) Size: 3.7 KiB ![]() ![]() |
Before ![]() (image error) Size: 3.6 KiB After ![]() (image error) Size: 3.6 KiB ![]() ![]() |
@ -147,7 +147,7 @@ You can build Horizon's documentation automatically by running::
|
||||
|
||||
./run_tests.sh --docs
|
||||
|
||||
The output is stored in ``./docs/build/html/``.
|
||||
The output is stored in ``./doc/build/html/``.
|
||||
|
||||
Updating the translation files
|
||||
==============================
|
@ -141,7 +141,7 @@ function run_pep8 {
|
||||
function run_sphinx {
|
||||
echo "Building sphinx..."
|
||||
export DJANGO_SETTINGS_MODULE=openstack_dashboard.settings
|
||||
${command_wrapper} sphinx-build -b html docs/source docs/build/html
|
||||
${command_wrapper} sphinx-build -b html doc/source doc/build/html
|
||||
echo "Build complete."
|
||||
}
|
||||
|
||||
|
@ -1,3 +1,8 @@
|
||||
[build_sphinx]
|
||||
all_files = 1
|
||||
build-dir = doc/build
|
||||
source-dir = doc/source
|
||||
|
||||
[nosetests]
|
||||
verbosity=2
|
||||
detailed-errors=1
|
||||
|
Loading…
x
Reference in New Issue
Block a user