Commit Graph

20 Commits (master)

Author SHA1 Message Date
manchandavishal d147750ab9 doc: Update our IRC server to OFTC
Change-Id: I0d5115c037f89aede2434442439f4ad465700338
2021-06-04 15:44:05 +05:30
Andreas Jaeger 4d85bab46b 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.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

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.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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

Change-Id: Ie14b87a1e67a7b4351f17a2f0687bcfe5a4b2133
2020-05-21 12:44:20 +02:00
Andreas Jaeger 30bb75d744 Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
- Switch to using sphinx-build
- Cleanup */source/ to remove now obsolete content.
- Use newer openstackdocstheme version
- Use mock from unittest;leave it in test-requirements for now since
  otherwise lower-constraints fails since some repos expect mock to be
  installed without requiring it.
- Remove future imports, not needed for python3
- Update to newer hacking version for python3, disable one warning.
  Remove hacking requirements from lower-constraints, they are not
  needed there.
- Cleanup tox.ini, move basepython to top
- Update horizon requirement for ussuri

Change-Id: I1753bce3ac4fc4248783c0669cacab2e037e62fe
2020-04-12 19:01:57 +02:00
jacky06 e5535b47c2 tox: Keeping going with docs and cleanup setup.cfg
1. Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be

2. pbr hasn't need the hook configuration since forever [2]

[2] c84876dc0f

Change-Id: I421c88c7c5d2b494443986607e9ddfb87c02bc72
2019-10-24 08:50:35 +08:00
licanwei e0405ceff6 Build pdf docs
Add a new pdf-docs environment to enable PDF build.

Change-Id: I9691132f542242716992d2f842f1261b7cd30389
2019-09-17 01:26:37 -07:00
zhulingjie 3e969179a2 Replace URLs with URLs
Thorough replacement of URLs with their counterparts.

Change-Id: Id8f56526b61f3ea85835c73666f97e0e4e7e2ffe
2019-04-28 17:14:49 +08:00
Ian Wienand f1f1e5542d Replace git:// URLs with https://
This is a mechanically generated change to replace
git:// URLs with https:// equivalents.

This is in aid of a planned future move of the git hosting
infrastructure to a self-hosted instance of gitea (,
which does not support the git wire protocol at this stage.

This update should result in no functional change.

For more information see the thread at

Change-Id: I9e1ad83e6a63f5f7d42335342483b1d3262a9dde
2019-03-24 20:36:26 +00:00
melissaml 6e493adbd5 Update devel info: mailing list
Mailinglists have been updated. Openstack-discuss replaces openstack-dev.

Change-Id: Id4ca6d46070867213ccd58519cf6ca33618333e6
2018-12-15 16:22:07 +08:00
melissaml 1b54213301 Delete the unnecessary '-'
Fix a typo

Change-Id: I513e201b6f67dec3ffe64259531a5cae199242c8
2018-03-22 00:05:27 +08:00
ShangXiao 28ea3faebc Fix url links and spelling error in docs
1) Replace old http links with the newest https ones in docs.
2) fix a spelling error in HACKING.rst.

Change-Id: Idf087b08fd0053c95b9d9d139fa4269c258c95af
2018-03-02 00:18:42 -08:00
gaofei 191d2dbd3e Update unreachable link in installation doc
Update unreachable link in installation doc.

Change-Id: I41712f1117025f791243a3cefed879287b8817aa
2018-02-08 03:13:12 +00:00
lingyongxu 8cd80d9842 Update the documentation link for doc migration
This patch is proposed according to the Direction 10 of doc

Change-Id: Ic462f92bba426ff1767b5d7b8728aad7f87759ab
2017-08-07 15:02:53 +08:00
Jenkins 49789ada6a Merge "switch to openstackdocstheme" 2017-07-25 13:38:25 +00:00
Alexander Chadin eeeb3efca1 Update docs to the new standards
This patch set updates docs structure and adds
contributing page.

Change-Id: I7ec68524e91e1bf42754802e7ea79086e301c836
2017-07-24 11:03:32 +03:00
Yumeng_Bao cbfa8bf76e switch to openstackdocstheme
Change-Id: I71aac9c5e629e88fa8009ce4b303c658c3e37fd2
Co-Authored-By: chenxing <>
2017-07-12 11:35:33 +00:00
Antoine Cabot d9852e7215 Add [watcher] tag when using OpenStack ML
When sending an email for support, tag [watcher] should
be added in the object field.

Change-Id: Id36edd5919ed9c18d758156a2bf854f53b48afb7
2017-02-02 10:45:22 +01:00
Rajiv Kumar a5437e642f Remove link to modindex
The documentation build does not generate any module index, thus
remove the link to the page. The page
does not exist.

Change-Id: I84e0f003992b3018c3374c85bc8149bd1ac1bcbb
2017-01-25 09:34:46 +05:30
avnish 64c0aa961d Removed unnecessary utf-8 encoding
Change-Id: I0bc95a6eb4a9347a85abd1712feb54bfdc958f0c
2017-01-11 15:44:59 +05:30
David TARDIVEL 8e7eff49b3 Moved README.rst content to installation.rst doc
Changeset will introduce
a new badge for this project, including a external svg image. This
update will produce a bug because README.rst file is referenced by
the deploy/installation.rst file. So I moved README.rst content to
deploy/installation.rst to fix it.

Change-Id: I4074baba8e1fea67410710b6565374dcb927e7a2
2016-12-15 09:47:55 +01:00
Vincent Francoise b4fb6f7573 Watcher Dashboard - Initial commit
This patchset puts in open source the code initially made internally.
This dashboard follows the new plugin architecture that Horizon

Implements: blueprint watcher-ui

Change-Id: Ic8736b45ae5e111a817f64568ed0534c1521c84d
2016-02-17 13:38:41 +00:00