Commit Graph

5 Commits

Author SHA1 Message Date
Ghanshyam Mann b11daba48d [ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38522
Change-Id: I0e2d1de8e96bbfe5964983d021eacc9e62265f86
2021-05-31 20:30:06 +00:00
Andreas Jaeger e4b0b9377e Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_name to use 'project' variable as name.

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: Ia7f902cce276b8e9bbc62a6f75e123521e471289
2020-05-30 16:49:37 +02:00
Andreas Jaeger a15380550b Update docs building
Update docs building:
* Switch to sphinx-build
* Update requirements for Sphinx and openstackdocstheme for
  python 3, create doc/requirements.txt, switch to openstackdocstheme
  from obsolete oslosphinx
* Remove unneeded doc and translation sections from setup.cfg
* Remove install_command, it's unneeded, the default is fine.
* Move constraints into deps, use TOX_CONSTRAINTS instead of obsolete
  UPPER_CONSTRAINTS
* Switch to hacking 3.0, fix problems found

Change-Id: I44d09a65349a1d9b564e69a7fc32eb435446245c
2020-05-03 12:03:41 +02:00
jacky06 7c1db8fe06 Sync Sphinx requirement
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Update some URLs to latest
3. Remove unncessary "=="

Change-Id: I211039189a935e006dc77d3245486d72b7c104a9
2019-09-13 01:50:21 +00:00
Saad Zaher e6d6395a38 Big Bang :) 2017-06-09 16:09:38 +01:00