As we run into a nasty setuptools issue/feature which broke even
tox -edocs, add py_modules=[] to setup.py's setup call, see [1].
[1]: https://review.opendev.org/q/topic:setuptools-issue-3197
Change-Id: I24adbcb9076f02c2eeefef98c21a4ccf247b0c5b
sphinx seems to not finding paths for images files, but adding a symlink
to doc/source make the doc build work again.
Change-Id: Icf8e867c21252e0d098e45630dcb8399eb6386ab
Closes-Bug: #1916332
In python3, all strings are considered as unicode strings
and the unicode prefix ("u") for string is no longer needed.
This commit cleans up "u" prefix in the repository.
Change-Id: I30a9f5314aef1160766af608043c073d333f1bff
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I61c96d3f8479b6ab5eef993a769f1fc7df78c6ad
Make a few cleanups:
- Remove obsolete sections from setup.cfg
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine;
cleanup tox.ini for python3
Change-Id: I306fe1dd080839004e206ac08f3526812e406f19
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: Iae624665505cc5948756318ecf2914678c103461
- Update outdated links in README
- Remove skeleton.rst, this file is unnecessary.
- Add Stein Specifications dir.
- Move placeholder.rst to stein dir, because there
is a blueprint accepted in rocky dir.
Change-Id: I5fd436db02517404d3aca3114498206f164bca44
After switching to openstackdocstheme, the left side menu lists
all specs and it is no longer useful as navigation.
This commit reorganizes the doc structure and toctree so that
the toctree is easy to read with openstackdocstheme.
Change-Id: I47a8c28c038bf2022855a81f6073f4b5f4b01266
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
To handle this, this commit changes:
- Introduce doc/requirements.txt
- Update tox.ini [docs] target for developer convenience
- Fixes a lot of warnings caused by a newer sphinx 1.6.5 because
sphinx specified in upper-constraints.txt is used in the new PTI.
- Drop unnecessary [pbrp] warnerrors in favor of warning-is-error.
Change-Id: If40305044c9dfe0024b64bd3921232bb0a6c9372
This is following up of [1] to open stadium doc structure
for Queens.
[1] I80e4aefe5700f6c1dcf1037f22bf58b5d23ea95d
Change-Id: I2a00a7555134a5bcf42385695bd04e207eeb96fd
Co-Authored-By: Armando Migliaccio <armamig@gmail.com>
* Move Pike incompleted efforts to backlog
* Archive Ocata specs that were not reproposed for Pike
* Open Queens directory.
Change-Id: I80e4aefe5700f6c1dcf1037f22bf58b5d23ea95d
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: Ida74c8af2b28124048fcba39cd1f44ce4db3c713
Closes-Bug:#1693670
pbr 2.1.0 has a regression that it always tries to build 'man'
and this causes 'WARNING: "table cell spanning" not supported'.
We specify warning-is-error = 1 and as a result all documentation build
now fails.
This can be fixed by excluding pbr 2.1.0 in requirements.txt.
Note that pbr 2.1.0 is already marked as blacklist in global-requirements.txt.
'man_pages' config option is also dropped from doc/source/conf.py
as we are not interested in manpages as output at all.
Related-Bug: #1681983
Change-Id: Id9aa7b128ad8d4af5db6b96a758f1134a774db1b
This patch introduces a postmortem template for the
Neutron project, and brings a draft for the Mitaka
release that would need to be filled with the help
of the Mitaka contributors before Mitaka is released.
Change-Id: I30aac4e8adf57ab891f47cb7c4841d55c1422e00
This patch moves forgotten Liberty material to the archive
section and preemptively move incompleted Mitaka effort
into backlog section (to be resubmitted as soon as Newton
opens up).
Change-Id: Ia1a3931881ea6ac65e6c4577d51f53dad5934ba3
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Closes-bug: #1529836
Change-Id: I2b7a30e79bda60f66431a75b0877fe3f3237f9cf
Instead of having a per-release backlog directory, create
a top level one that holds the last release backlog. In
a healthy project this directory is really meant to be
empty or only temporary filled.
For specs that are two releases older, the content will
be moved to an 'archive' directory, purely for the record.
Hopefully this one too will be empty.
API and Juno incubator were moved to a miscellanea
directory to finish off the cleanup.
Finally, some blueprints completed and therefore were
moved to the Liberty directory.
Change-Id: I972a9a56c038864d9c91ead6944c6b9355916668
It is too difficult and time consuming to track this by hand and
the section essentially duplicates information that's avaialable
in Launchpad.
The idea of highlighting who does what in a cycle is nice, but
this needs some more thinking.
For now, kill the section, which strikes as odd amongst the
other content of the landing page.
Change-Id: I78f18ed8418f01599fd6acb58317c70bb7f633e1
This commit adds the mitaka directory in neutron-specs and opens it
up for submissions.
Change-Id: I6368456c14ea70b9faabdc70f2961c8c0511e1c9
Signed-off-by: Kyle Mestery <mestery@mestery.com>
Specs which were targeted at Liberty but which did not make it in time and
have no FFE are moved to liberty-backlog. They can be re-proposed for
Mitaka when we open up specs for that release.
Change-Id: I915ccdf594569822daff03d9bcc0e8536db783bf
Signed-off-by: Kyle Mestery <mestery@mestery.com>
This commit moves specs which didn't land in Kilo into a new
kilo-backlog directory. It also cleans up specs (both ones which
landed and ones which didn't) which lacked a proper Launchpad
link.
Change-Id: I773381b27b54c77acf0fde0a045203ddbaa9a64d
Following the Kilo Summit in Paris, this document will track priority items
which the Neutron team is tracking during the Kilo cycle. I've added a main
point of contact for each item, along with a brief description of the work.
Change-Id: I65b7061f15402785256b05f9ab2152d6efc747e6
Goal is to start maintaining API specs in the specs repos for each project
to eliminate maintenance of <project>-api repos.
Change-Id: I01faed48fa7ab8fd66c77d43f859d30ba4f66eb7
Previously Juno and Kilo blueprints are listed in one list.
This commit adds section titles per release.
Change-Id: I69f6c4bb969a3e7e7a58365dfc8f2275025f5440
Roberto Bartzen Acosta