13 Commits

Author SHA1 Message Date
Tony Breeds
6d50d95cae Skip the .tox dir when building docs
When running tools/build_docs.sh in a devstack dir that has also run tox
build_docs needlessly runs shocco on the .tox files.

Just skip them.

Change-Id: Ia561e49ea2214ac75bd55964f1b86872118b2031
2015-05-29 12:26:31 +10:00
Dean Troyer
dc97cb71e8 Mostly docs cleanups
Fix documentation build errors and RST formatting

Change-Id: Id93153400c5b069dd9d772381558c7085f64c207
2015-03-28 14:35:12 -05:00
Dean Troyer
bf2ad7015d Move configuration functions into inc/*
* config/INI functions from functions-common to to inc/ini-config
* local.conf meta-config functions from lib/config to inc/meta-config

Change-Id: I00fab724075a693529273878875cfd292d00b18a
2015-03-09 22:52:19 -05:00
Dean Troyer
b3fdb1c935 Simplify docs build
Remove unnecessary old code from tools/build_docs.sh; it now only builds
docs for the current branch in the current working directory.

Fix the merging if the git log changes into changes.html.

Change-Id: I965dc3383b6317807ca0d47fe42648a19e96b57b
2014-11-17 12:45:12 -06:00
Monty Taylor
0cbddea50d Move the doc paths to match other repos
In order to build in the Infra system, we'd like to be able to reuse the
existing doc build macros. To support that, move docs/source to
doc/source and docs/html to doc/build/html.

Change-Id: Ibd8e8e82e54c69b182120df67e6ec6908fed2908
2014-10-14 12:13:07 -04:00
Davanum Srinivas
690e3c2574 Fix Typos found with misspell
git ls-files | grep -v locale | misspellings -f -

Change-Id: I0dc56ba64ae4bdc681ccf4a1d2d23238f541650d
2014-10-05 20:06:33 -04:00
Dean Troyer
926c99d072 Generate recent changes list from git log
The list of recent commits to the DevStack repo is now generated
by tools/build_docs.sh from the last 6 month of the git log.

Change-Id: Idefdb5d5188ab7e743af131e3d6cb132382d25d4
2014-07-03 15:57:38 -05:00
Dean Troyer
54b9732339 Move static docs into master branch
The hand-maintained static HTML docs for DevStack have been in a
GitHub gh-pages branch; move them into the master branch in
preparation for hosting them in openstack.org infrastructure.

By default tools/build_docs.sh now builds the static HTML output
into docs/html.

Change-Id: Ide5f7d980a294c7a9f8a3decaed0939f1c239934
2014-06-20 18:04:55 -05:00
Sphoorti Joglekar
ce365ce1cc Edit docs to include git.openstack.org url
This patch proposes a change to clone the devstack repository from
git://git.openstack.org rather than https://github.com since git urls
are faster than https and put less loads on the server.

Change-Id: I7fe6a0f81be812dacfef575caa1cf0ae800f9a29
2014-04-02 18:35:21 +05:30
Jenkins
99da4af55e Merge "Robustify shocco install and config" 2013-11-25 19:35:54 +00:00
Dean Troyer
c04ddbe868 Robustify shocco install and config
* shocco has some non-optional prereqs, make sure they are present if
shocco is being installed
* set the path to installed shocco correctly
* add the working dir to .gitignore

Change-Id: If786ea9e28d3595775f7b86d2fe760dff8047f49
2013-11-06 21:46:20 -06:00
Adam Spiers
4b2c5ed209 only clone docs from gh-pages branch if they aren't there
Allow the caller of this script to decide which commit
from the gh-pages branch should be used to build the docs.
This also avoid excessive repeated git clones during development.

Change-Id: I3e58eef0ac03b15903c06d5632c0eb41413db02c
2013-10-24 17:40:13 +01:00
Dean Troyer
9b973670a6 Add the doc build tools
tools/build_docs.sh generates the devstack.org website from the static
pages and generated pages created by running shocco against a DevStack
checkout.

Note that while this is the complete auto page generation of the
devstack.org site, pushing the content back to GitHub is limited
to those with push access to the current repo.

Partial-bug 1235626

Change-Id: I61dc3d56e4a4832a9ddd1904dd8af65c15a17e50
2013-10-22 15:06:35 -05:00