This is needed for some OpenStack CI testing, it will be removed once
the job is working correctly.
Related Change: I7343d54185a896b847d6340532bdab22465e98f0
Change-Id: Ib6d45031866790ee73000cf514e1263a7e8dff69
To simplify the build tool chain,
factor out Install Guide for Debian with debconf.
Continueously, keep Install Guide for Debian without debconf
in the doc/install-guide directory. Also, use the contents
at doc/install-guide as possible for consistency.
On the following patches, clean up doc/install-guide sources
to cleanup the contents and build tool chains.
Change-Id: I8df6b3b382137d08d60f85bc41bcd98ac1f4eb47
Since we do not build DocBook XML anymore, we have removed the jobs for
this and thus can remove the support for these also from tox.ini.
checksyntax, checklinks and checkdeletions are DocBook XML only targets,
so remove them.
Change-Id: Iaa663c03fd6e2976208e20ba03dbab4d8d82b2ce
Depends-On: I9f5944eb9db06fe2ff9088f22048c198b2921237
We do not need the DocBook XML glossary anymore, since we do not build
any DocBook guides that use it.
Add instead the RST version of the document to git.
Adjust scripts to not build or publish the glossary anymore.
Change-Id: Id4bfef7666690e6d08291f664751db7a4d4d5983
Move release notes into releasenotes and add tox target so that
infra scripts will publish them to
docs.openstack.org/releasenotes/openstack-manuals
Infra change: Icbe135e37c78e0a3a1c6d3243f7128c0b881325d
Note that the directory layout here is this way on purpose - we want to
reuse the same jobs other repos use, just the difference is we're not
using reno for this.
Change-Id: I00a53d8b3d9bef28b480be22af2e6647fa26448a
"pipeline" must be only one line in ceilometer-swift.rst, which it
easy to misguide deployer to four lines before this patch set.
Change-Id: I2c2af5d026b335394660780913c9bbb2392e3b7c
Prepare the networking guide for Liberty/Mitaka updates as
follows:
1) Change "legacy" to "classic" to provide a more positive
connotation of such scenarios. Legacy should refer to
nova-network.
2) Replace underscore with hyphen in filenames to meet
conventions.
3) Replace :doc: with :ref: to minimize impact of future
file renames.
Change-Id: I95bdd84b4a01cd9cbd06cad66821ad810295394f
backport: Liberty
As discussed via email, let's do this on a smaller scale.
This reverts commit 9432a6da0cc341a879bc6f4ac48380248355e77a.
Change-Id: I27e9cd06c5d69917abe452e873873683e10c282a
With this environment it is possible to build a single RST guide with
the following common: tox -e build -- NAME
E.g. to build the contributor guide run the following command:
tox -e build -- contributor-guide
Change-Id: I94cf504eece14b2b8d2734cb5b4c16a1b409026f
Enhance file so that it can be used by other documentation repos as
well.
Update invocation of it.
Change-Id: I93a6d8ccb8c314c0961b87a239462183712cdd26
Check RST files for valid links.
This is a separte target for now to evaluate how useful it is.
Whitelist build.opensuse.org URL for user-guide.
Remove also checklang from default tox invocation since it's not needed
to run by default.
Change-Id: I6c275518b9e55ab3b6bcea52894ea851924bee94
With this patch, the RST files have no line longer than 79 chars -
as discussed on the docs mailing list - and we
can gate on it. Previously this limit was 100 chars.
Change-Id: I23f550db81e9264649d0444f5f1ba1be0d6d343d
Add support for conditionals for the Install Guide.
This uses the tags:
* rdo
* obs
* ubuntu
Note that this is changed from the spec since sphinx does not accept a
"-". Also, I changed from opensuse to suse for brevity.
Adds new tox target so that "tox -e install-guides" builds only the
RST Install Guide.
implements bp installguide-liberty
Change-Id: Ibdfbc7ff294e56f52cd6f4ef59ceeb7b6af3e28a
We aim to have no lines longer than 79 characters, enable the line
checking niceness check but set it to 100 as current maximum.
Convert files that fail this line length.
Convert one table to a definition list, convert two tables to use
list-table directive.
Change-Id: I8d0a95cc1c8e72965b3e0e69445e7b2bc6d77f0f
Remove separate build-user-guides.sh and create a new build-all-rst.sh
tool.
Remove networking tox environment, since the RST guides share files, we
should always build them together using the docs tox environment.
Change-Id: I7ef98ca5e134096e14c79d58b0fc62a07747e471
openstack-doc-tools 0.28 contains a fix for translation of RST guides
and the User Guides. Require that version and enable the User Guides for
translation.
Add building of glossary for translation environments to tox.ini.
Change-Id: I645bf98b68603811a9a978e508d1f492e44da738
The two tox environments were large and mostly duplicated, use a shell
script instead and use the build-rst.sh script to simplify building and
publishing.
For copying to /kilo, use the tools/copy-to-branch.sh script instead of
the simple commands since that is more robust. Merge that script into
this script, no need for a second script.
Update requirements: We need 0.27 at least to not have to delete the
Debian Install Guide, sync also pbr with global-requirements.txt.
Change-Id: Ieba77b4e3d0bbe58db041206d9725c523b3bb43a
Separate User Guides cleanly, there's little benefit in having them in
one directory and it causes quite some strange sphinx challenges.
Temporarily disable translation of the guides since first a new release
of openstack-doc-tools is needed.
Partial implements bp reorganise-user-guides
Change-Id: I9e41bb67397c5bc26c1940f67387f3e42a9c5cbc
If no documents are published to /draft, the "cp -a" would fail, rewrite
it so that it always succeeds.
If any command fails, nothing gets uploaded ;(
Change-Id: Ib9c6254504f868fd1a8eb772d5df9651448adc42
Publish draft documentation on docs.openstack.org/draft.
For now these are all Install Guides and the French Image Guide.
Update wiki pages for new links.
Partially implements bp draft-publishing
Change-Id: I319a52f7bc9982ab172fbbbaeb0a22a7642b5b07
Require openstack-doc-tools 0.25. This allows us to remove the content
directory for RST checkbuild.
Change-Id: Iffbdbb312c4e74902aec3cd4ebbfb5e4a4d83a76
publishdocs failed when there was no content in publish-docs/draft and
then did not publish any files.
Failing is fine for the sed command, so add a "|| true". Also use
"mkdir -p" to ignore errors if publish-docs already exists.
Change-Id: I2cdcf155f583057fc56392ec44d8affffceafc9c
Copy over the Config Ref and Install Guide to kilo locations until
we branch of Kilo.
Publish networking guide continously.
Change-Id: Icdd1c5a841b804309e4c04f03c7b5607d670719e
Enable doc8 but disable D000 (RST validation) and
D001 test (overlong lines). This also disables
all the problems we had in the past with doc8 checking, the current
files pass doc8 after fixing a few minor problems (part of change).
This basically tests for whitespace.
Change-Id: I648ac7f78b3a31f3b1434dc7d7d0b887ce4d5128
Publish Install Guide to docs.openstack.org/draft/install-guide
Publish Networking Guide to docs.openstack.org/draft/networking-guide
Publish Configuration Reference to /draft as well.
Update link /trunk/index.html
Partial implements bp draft-publishing
Change-Id: I620339c45e07bc492328f8df908e7b9f5f5ef9fa
Remove DocBook User Guides and also the moved hot-guide.
Publish RST User Guides instead.
Remove workarounds for old tools.
Change-Id: I3fcc3972452959183c099daaf8226d7734445650
Automatically convert the glossary from DocBook XML to RST with each
build and use it for building the RST guides.
Add the glossary to User Guides and Networking Guide.
Use glossary in User Guides in places where it was used before. This
removes one TODO.
Fix CORS capitalization.
Partial-Bug: #1421813
Change-Id: I3fba6d54b01759f39f8e1467a7606cdbd2dd0165
Publish User Guides as:
docs.openstack.org/draft/user-guide/index.html
docs.openstack.org/draft/user-guide-admin/index.html
This allows us to review that everything works. Once we stop publishing
the "old" guides, we have to adjust the publish location.
Fix also location for the check queue.
Change-Id: I3dd0a5fc3ed9d253af0fbc201a03cd45e5be75fd
Create titles for both guides to differentiate them.
This needs a separate top-level index file and some moving of files
around so that the finished guide has an index.html file.
Change-Id: Ibe23d0c466b5c5f7d0b909548b55f6c5382f8992
Exclude the SDK and Cheat Sheet chapters from Admin Guide with
marking them as user_only.
Use user_only tag for this for building the User Guide.
Change-Id: If0b9ef8c374f5a4ef2a0fadc8cda9b063d0c44ae
- Uses -t admin_only tag for building the admin version of the user guide.
- Add files to cli.rst that were not included anywhere.
- Add flag -E to sphinx-build to ignore old content which might lead to
strange local build bugs.
- Add build-admin directory to .gitignore.
- Fix scope.py extension to properly remove files from toctree.
Co-Authored-By: Andreas Jaeger <aj@suse.de>
Change-Id: Ide51cf83c148060d3064ebcb9535b3d3a29c83cf
- We're not at a point where the value proposition in consistent markup is
worth the pain in troubleshooting.
- Plus I think the current checks aren't sophisticated enough to replace humans.
Change-Id: Idb4e4acaf6b274024853847aa1d77324e251349f
Set locale_dirs in conf.py to support translated documents building.
Add a config variable SPECIAL_BOOKS to list documents in RST format.
Add new generatepot-rst tox environment to generate all pot file,
invoke using "tox -e generatepot-rst -- playground-user-guide".
Add new script to generate the pot files.
Co-Authored-By: Andreas Jaeger <aj@suse.de>
Change-Id: I3124cf65b254c1c5aefce59447bb94240d96a742
Patch was originally trying to use python setup.py build_sphinx to build the RST guides.
Thinking it'd give us better debugging info. But now translation needs a /source subdir.
Change-Id: I5e4f85846301bb14fcd9fb1445b08a0d34d16cae
Treat warnings as errors when building RST.
Fix warning about wrong reference in sdk files and about
file not included anywhere.
Change-Id: I3cfd054b6bacc205991e2f57795d183a21275c21
