Commit Graph

14 Commits

Author SHA1 Message Date
Takashi Kajinami efef85fe4d doc: Comment out language option
... because explicit language=None causes the below warning since
Sphinx 5.0.0.

Invalid configuration value found: 'language = None'. Update your
configuration to a valid language code. Falling back to 'en' (English).

Change-Id: Ia7aca32a786e438bf8b778c8ec9350d8d6d94a24
2022-06-06 15:34:07 +00:00
Ghanshyam Mann 70b1d06456 [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: #38524
Change-Id: I9672ee1011b06b86ba4df331cd1149a18bc1f408
2021-06-01 02:08:59 +00:00
Andreas Jaeger 0e188d0326 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: I0494a468b8ccc54e6d6946623a44ece6442d1915
2020-06-16 15:40:18 +02:00
ricolin 7872568ed9 Revert "docker-cmd hook switch to the paunch library"
This reverts commit 33241a84c1

The requirements check fails since
Ia4e086162e65a51af417a8b381ae898c95966a09 removed paunch as valid
dependency.

Since Paunch is retired, this patch propose to switch to use docker cli
for docker cmd hook and remove any dependency to Paunch.

Change-Id: I9c3839e551259fb85b191a27fa054c605964f30e
2020-06-11 17:31:17 +08:00
Andreas Jaeger dd7efc353e [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Cleanup tox.ini, remove install_command and add constraints to deps.
Replace mock with unittest.mock.

Change-Id: Idcac0b5310adf27a35223273bd54a4a154988c9b
2020-02-04 20:21:41 +01:00
Zuul acfa067059 Merge "Drop use of git.openstack.org" 2019-09-04 06:15:25 +00:00
ricolin a7f26c14eb Drop use of git.openstack.org
Our cgit instance will be going away and opendev.org is the new
preferred URL for browsing our git repos. Redirects will exist for the
foreseeable future, but it's more efficient to just go directly to the
new locations.

Change-Id: I8f9fbe12b5230e527faaea9fe25d71292a75caa1
2019-09-04 05:55:18 +00:00
xuanyandong a79c6b96ed Cap sphinx for py2 to match global requirements
Change-Id: I57fe9dd2b5e62f14dc2c91da607cc7cfea5f0ba7
2019-09-04 05:50:47 +00:00
Christian Berendt 4f940ec270 Fix broken git.openstack.org URLs in the docs
Change-Id: Ieb809d57570a33fa2df03502c5c06cf7da5acfdf
2018-11-23 22:15:31 +01:00
zhulingjie 61b07f536b Migrate the link of bug report button to storyboard
Change-Id: I85439200113a719f2e1c7caea29ea8de57cb0a8e
2018-08-30 07:15:46 -04:00
Zane Bitter 461013f01c Clean up heat-agents docs
Improve links, formatting, grammar.

Change-Id: I459b40f30ccd613e19d20e342948f19be1f01efd
2018-03-26 16:32:53 -04:00
ricolin abd634b8b6 Create doc/requirements.txt
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

Refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html

Change-Id: I3ca83de4daa7f3433d62aa0868550ad8695968a2
2018-02-02 20:17:28 +01:00
rabi 6e8e631d34 Organize heat-agents docs
This organizes the heat-agents docs as per the openstackdocs format.
Also adds the team and repository tags.

Change-Id: I997dd3f52c9cd9f8ea274520e033de3ef582401c
2017-08-04 08:52:27 +05:30
rabi bd91db747d Add basic stuff to build docs
This adds basic stuff for docs job.

Change-Id: Ifedc400ea6ee8fb8402b0044553dea4e154ffe96
2017-07-20 09:12:08 +05:30