Commit Graph

13 Commits

Author SHA1 Message Date
jinyuanliu 154d6ee138 docs: Update Freenode to OFTC
http://lists.openstack.org/pipermail/openstack-discuss/2021-May/022780.html
Change-Id: I61a403bacaead2d5af078c921bcb96c20f4dffe9
2021-06-02 06:23:55 +00:00
Andreas Jaeger 78ae004de1 Switch to newer openstackdocstheme version
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.

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: Iecd379c54ddbd4aedb45803897f33f31203b8048
2020-06-01 15:50:00 +02:00
Matthew Thode 67fe92ce16
add contributing docs
Change-Id: I187458290a52c64bcf8ea5f0be5f2021efbca4f8
2020-04-22 23:27:05 -05:00
Andreas Jaeger e58863cb65 Small docs cleanup
The repo is now using python 3 for docs building, so remove py27
requirement, update openstackdocstheme version and remove unneeded lines
from doc/source/conf.py.

Change-Id: I65a443018b4ffa375df30357085b1352af7cba53
2020-04-12 18:58:51 +02:00
Hervé Beraud 962dfa912d Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: I39079ec3e81cde2b1d8d8ef53219826298c61286
2019-10-10 16:17:25 +02:00
zhangboye 52cbe99b6e Cap sphinx for py2 to match global requirements
Change-Id: I9a22fd842cdea8dcda1900def51ad403d8bae9e8
2019-05-16 14:30:43 +08:00
Sean McGinnis 5e75d5d0b4
Fix docs environment
Change-Id: Iac612b8bf8d02f58f4677f3e1104d99cacce5b23
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-05-11 13:46:51 -05:00
Matthew Thode 01ccedef0e
Rebuild docs: DRY edition
Point to the dependency management docs for general review guidelines and
add docs for the freeze process.

Story: 2003792
Task: 26500
Depends-On: https://review.openstack.org/615388
Change-Id: I5adb28faaeb19735445450c26bcf40ecd5336a9f
2018-11-03 14:32:03 -05:00
Andreas Jaeger 51fbfae5d8 Fix bug URL for report a bug link
Launchpad is at openstack-requirements, fix wrong project to support the
bug icon from docs.

Change-Id: Ifc144165410cce36ab5d6be9023832ada02b9e59
2017-08-27 10:42:10 +02:00
Andreas Jaeger 29e92f930c Switch to openstackdocstheme
Use openstackdocstheme instead of obsolete oslosphinx.

Fix display problem with removing extraneous whitespace in README.rst.

Change-Id: I791e830c6a13476152fb26a95de6832a6c50adae
2017-08-26 14:57:42 +02:00
Dirk Mueller 41b9a31795 Correct latex_document settings for Sphinx 1.6.3
Sphinx 1.6.3 is starting to validate the latex_document
settings which caused documentation build to fail as our
settings were invalid. With this change the validation passes
on 1.6.3 which unblocks the gate.

Change-Id: I1fb81ea1d7de561185a6ae31dd4bc73e1ac8f9ae
2017-07-04 09:06:43 +02:00
Andreas Jaeger cf2374aac2 Use oslosphinx for doc build
Since this is now published on
docs.openstack.org/developer/requirements/ , update theme to use
OpenStack branding.

Include the oslosphinx extension, rename base names from DevStack to
requirements.

Change-Id: Icedd2bbce155b4667c6fe205ca61b9f707a1a8b5
2015-10-05 16:24:14 +00:00
Ian Wienand cac04e0db2 Add simple doc publisher target
Add a simple doc publisher target that just includes the existing
README.

Some of the infra jobs that fail requirements try to point you to the
requirements documentation; currently this is given as a raw RST link
to the web-view of the git tree.  It would be nicer to publish this as
formatted HTML like all the other docs.

Change-Id: I56b60a950c64880dd551d11e1997cd5ecbae283c
2015-09-29 20:33:12 +10:00