Commit Graph

6 Commits

Author SHA1 Message Date
Ghanshyam Mann
36b15031e9 Update IRC network to OFTC
Change-Id: I66b8412e61cec0b77ea63e4551ba3f082892bd38
2021-05-31 15:05:57 -05:00
Goutham Pacha Ravi
1cf06c0dee TrivialFix: PDF and doc corrections
Remove a limitation from the README that's
not relevant any more and stop rendering
the search page in the PDF.

Change-Id: I4c3409c9a6384adf0c20ab08214b866063d4dea5
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2020-10-08 15:25:43 -07:00
Lukas Piwowarski
bc1beebf38 Create tox environment to build pdf documentation
This patch enables building .pdf documentation using new 'pdf-docs'
tox environment. The newly created tox environment creates latex
source codes using sphinx-build and then builds the pdf
documentation using make.

Also, convert README.md to README.rst for more seamless integration
of the README file in the pdf and html documentation.

Story: 2006070
Task: 35457

Change-Id: I5c022478c9be0067c125efb4032c16cf0978330f
2020-10-01 09:23:00 +02:00
Andreas Jaeger
6a252c1991 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_auto_version to not auto-version the documents.

Set openstackdocs_auto_name to use 'project' as name.

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.

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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I71e78d4ff18b0fd92f16f0917283eddad543250f
2020-05-22 17:30:32 +00:00
Ghanshyam Mann
6f1a6e2b9b [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: #38554

Change-Id: I1b544695dc5cc1c9f2cdd5fc3f686dae94d52aaa
2020-04-22 14:07:07 +00:00
Ghanshyam Mann
65b5986a9e Set up the doc infra and add doc job
devstack-plugins-ceph does not have the doc infra set
up and no doc publish job.

This is need to add the contributor doc as per the ussuri
community goal.

Change-Id: Ib62c34b52b28b753f7f3046d51492fd8d9fb6193
2020-04-22 00:54:27 +00:00