The build directory is created by setuptools when a package is created.
The file RELEASENOTES.rst used to exist as a manually managed file,
and is now created when reno is installed and a package is created.
The file releasenotes/notes/reno.cache is created when reno is installed
and a package is created.
None of these files should be tracked by git, so add them to the
.gitignore list.
Change-Id: Ia5e24a9d21ed2a0e51dd81b2cd3e44231c885fcc
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Noticed while playing around with PDF generation.
Change-Id: I6e2273cb20247cbb85b03e1abe1b8924f708e12b
Signed-off-by: Stephen Finucane <sfinucan@redhat.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
- Adds a theme variable, sidebar_dropdown, to set
a dropdown menu for the API references.
To test, uncomment the parameter html_theme_options in
doc/source/conf.py OR build the API Ref demo docs.
- Adds an API Ref docs demo integrating os-api-ref
and openstackdocstheme. Tested with webserver:
python -m SimpleHTTPServer <port_num>.
Change-Id: I346695cd407ecf4efc0a5e00f2c0ccc1ea099ec5
Add reno to automatically generate release notes - the same way other
OpenStack projects do it.
For details see
http://lists.openstack.org/pipermail/openstack-dev/2015-November/078301.html
This adds a version.py file to request the version of the repo.
Change-Id: Ia009f4cf73bd4188af3a126123d688438b97c994
Current documentation is Docbook-based. Each page features two
"log a bug" links near the top and the bottom. This bug fix
modifies the openstackdocstheme to do something
similar for future Sphinx-based documentation pages.
Regarding functionality:
------------------------
In the current DocBook-based implementation, a click on
"log a bug" opens a launchpad page with the bug summary and
further information prepopulated. Summary is the name of the
book, such as "Install Guide for Ubuntu - Icehouse"; an example for
Further Information is:
-----------------------------------
Built: 2015-01-06T17:15:01 00:00
git SHA: 233c8098bbdc5bc83bbd74403650feb6610f4b95
URL:
http://docs.openstack.org/icehouse/install-guide/install/apt/content/
source File:
file:/home/jenkins/workspace/openstack-manuals-tox-doc-publishdocs/doc/install-guide/bk_openstackinstallguide.xml
xml🆔 openstack-install-manual-icehouse
With our Sphinx-based docs, the Release value, git SHA, and source file should be sufficient. Here is the new functionality:
-------------------------------------
Release: 1.0 on 2015-04-06 12:27
SHA: c43d442c4d
Source: http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/source/index.rst
Change-Id: Ib60146d993ff67fc3f8fd8703cdad1935f7ec6bb
Partial-Bug: #1421799
Doug Hellmann