12 Commits

Author SHA1 Message Date
Takashi Kajinami
e0b93bcdc6 Drop unnecessary 'x' bit from doc config file
This file is not actually executable.

Trivial-Fix

Change-Id: I8856114716fee114d9b3966d1f88033cb5d6b797
2024-10-21 20:21:43 +09:00
xuanyandong
069d60ad37 remove unicode from code
Change-Id: I411ab8fb6783f0baa1d751de36649cddc8a06014
2021-01-03 15:14:05 +08:00
Lukas Piwowarski
4a02a8411d 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, this patch makes minor changes in the documentation source
code to make sure that the .pdf and .html documentation looks
good.

Story: 2006070
Task: 35454

Change-Id: I74a151163812a3dc8fde9f85739882a54ad11fd3
2020-09-24 10:27:28 +02:00
Andreas Jaeger
6a3769e077 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_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.

Create separate doc/requirements.txt file and use it, this allows
to continue testing with py35 and build docs that require py36.

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: Ic97beaec35ff633380688beb93318273ab6ca15c
2020-05-22 17:31:24 +00:00
Andreas Jaeger
e4162c215b Cleanup py27 support
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update classifiers
- Switch to using sphinx-build
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine

Change-Id: I40cf60b58847cee619bcac0a60c760bebd001954
2020-04-10 15:50:07 +02:00
Andreas Jaeger
465ed7e25f Update to openstackdocstheme
Use openstackdocstheme everywhere, this implies updating some
requirements.

Change-Id: I41db61936be63f92022c3f32cf6468a503e03dff
2017-07-21 08:43:47 +02:00
Ian Wienand
0661da9c91 Add reno & start at release notes
Add reno & start at having release notes

Change-Id: I747ccfd87cc56e0797ec899097a6e338c720692e
2016-03-07 13:08:39 +11:00
Ian Wienand
cffe2b5952 Add man page
Add man page documentation

Change-Id: I4b4994ac35684002dd9140fecbf9f1825dad4538
2014-10-29 12:33:28 +11:00
Christian Berendt
15bd1e25e3 Remove unneeded definitions of Python Source Code Encoding
PEP 0263 (http://legacy.python.org/dev/peps/pep-0263/) is not
used anywhere else and should be removed when it's not needed.

Change-Id: I08aa9e8e740c5f6506a76aaf5bea3402f97ac41a
2014-07-31 13:37:38 +02:00
Sean Dague
a2815dd86f the great rename of bash8 -> bashate
Once upon a time there was an inside joke, now it's even more so,
but at least it doesn't stomp on the namespace of bash.

Change-Id: I57c5d564fc60d93d154e750ba628277c771d2e66
2014-06-20 16:41:12 -04:00
Thomas Goirand
896fa8fd03 switch to sphinxdoc
bash8 is still using sphinx.doc, which isn't available anymore
in my build environment (eg: Debian). This patch replaces the
oslo.sphinx by oslosphinx in conf.py

Change-Id: Ia2b65532d62d31aa2ff5c17e20f11a0ee5dd3f8c
2014-05-17 03:30:25 +08:00
Mathew Odden
e545717e56 Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00