This commit is part of a series to retire the Packaging Deb
project. Step 2 is to remove all content from the project
repos, replacing it with a README notification where to find
ongoing work, and how to recover the repo if needed at some
future point (as in
https://docs.openstack.org/infra/manual/drivers.html#retiring-a-project).
Change-Id: I189a443db03e28aecde3700397808d9daf71dd55
This patch removes several of the varieties of headers set across the
docs. Generally it aims to make sure h1 - h6 have uniform color, weight
and size, as part of a larger cleanup.
Change-Id: I7103010868461e13c63af8d670aded610796282e
The javascript in place to make smooth scrolling work when a link points
to an anchor on the same page makes it difficult to send those in-page
references to someone, which is useful for sharing details about the
schedule. Remove it so sharing links is easier.
Change-Id: I4d52125299679ff9d2175eeefb05dc4663619081
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
When a page is rendered from RST input, show the full git URL pointing
to the source. When a page is rendered from a template (like genindex),
just show the template name.
Change-Id: I09e4214e370e6d3692c4c47bd9f7daa3b7396ebb
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
In the bootstrap CSS, the left-margin of <dd> tag is 0.
However, left-margin 0 sometimes (often?) makes it difficult to
distinguish <dt> and <dd> tags. I often feel this when working on
the doc migration reviews.
It looks better to have some left-margin for <dd>.
Change-Id: I0bf2ae73ae1453b5d102559fcf5f9535e5b8cf57
This patch adds support for the versionadded, versionchanged and
deprecated tags. It also reduces the rather aggressive margins and
padding around the admonitions, so that they stack a little better,
and adds a missing icon to the 'seealso' admonition.
Adds example admonitions to the Demo documentation.
Change-Id: Ieb064b26980f885549660a80e2a2578b71a5e7b7
Replace the static text "Project home page" with the project name and
version string.
Change-Id: I74a218285d8875c66b77611866a36ee08a01052f
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Sphinx 1.3 or later allows extensions to declare parallel reading
or writing is safe or not [1]. parallel reading is disabled by default.
I believe we can enable this safely.
[1] http://www.sphinx-doc.org/en/stable/extdev/#extension-metadata
Change-Id: Icd4b2c9951bb7bda3217cc814985dcd26ec5b5ce
Per the Sphinx documentations:
next - The next document for the navigation. This variable is either
false or has two attributes link and title. The title contains HTML
markup.
prev - Like next, but for the previous page.
If using the title value inside an element attribute, we need to ensure
the HTML tags mentioned above are stripped. Failure to do so results in
corrupted output.
Change-Id: I5fde1e6fc4d7966fcd3e767c79535202f3b41a71
Closes-Bug: #1702328
When building rpm packages, git might not be available in the
build env because it is not needed when building from a sdist tarball.
So make git optional.
Change-Id: I159768799fcf15ed0aea6b8350dd395f632e812d
If you run "git tag", the versions are listed in alphabetical order and
thus 1.9 is the last one - and not 1.12. Sort properly.
Change-Id: I64b6835b951d7d3547415743505d7a2e31dac632
Closes-Bug: #1702143
Point out the versions need to be found when this option is used.
With all the path changes, this is currently not the case for *any*
project.
Change-Id: Ie439db0bd5a1d5fbdb63eb3489a6c50bdf07ed6f
Some pages have no sub titles (the second level of titles or more).
In this case, the title string "Contents" of page local TOC is
completely meaningless and confusing to readers.
It is nice if this title string is shown only when needed.
This can be done by checking 'display_toc' variable in the template.
[1] https://docs.openstack.org/ocata/networking-guide/intro.html
Change-Id: I4803dd7712438eb2cd5fb6084e904bd8c0c98740
Lighten the background and darken the text colors in the
admonition.important box to make it easier to read the (important!)
text within.
Change-Id: Idb449c02a0a0832b5f379e53c373cc4dd1fe0e81
Allows setting of bug_project to a storyboard project number
to redirect to project page on storyboard.openstack.org for
report a bug feature.
Also, add some minor cleanups to doc/source/conf.py.
Change-Id: Ia14d30bf0dda89c48dec0a7cc3b8dccc26dc8d86
Move the existing test docs into a subdirectory and move the setup
details from the README to docs/source/index.rst.
Change-Id: Ic66247a1d5527cf1ba34f3b1561de6a027e12050
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
- First patch only modifies tox.ini to add an html-only
build option to iterate quickly.
- Modify .gitignore for working on Mac OSX locally.
Next patches in series will take care of:
- Adds a Project-only search form in bottom of left-hand navigation bar
Trying to differentiate between project-scoped search and broad
site search.
- The "Project Home page" link renamed from "Contents" in nav.
- Build number now available in lines "Updated" also is
displayed. Shows a bulleted list with "Current" if that is the
only available version. Seems to have a lot of space, okay?
- Add a link to project source in sidebar.
Change-Id: Ic71c1f7c17048c521fce4b08989b0c57c175e043
Tony Breeds