Commit Graph

15 Commits

Author SHA1 Message Date
liyou01 5652b0f0cd remove unicode from code
Change-Id: Ia725b1c2210822b7e74a8bcf25a36ac94dfef90f
2021-01-03 17:41:48 +08:00
Andreas Jaeger 80bcdd2aab 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 docs.openstack.org
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.

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: Iedbe8c96c57403d5ee7208cc89bddd9809b70eb2
2020-05-23 18:08:38 +02:00
Andreas Jaeger 2abc37868b 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 setup.py
- 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
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
- Update to hacking 3.0, fix warnings

Change-Id: If66a87c519ce82ee7890ac3e133afef13fb35bd2
2020-04-13 11:28:10 +02:00
Stephen Finucane e74127862a docs: Misc cleanups
Moe the installation and contributor "guides" under 'install' and
'contributor', respectively, and remove some noise from the root index.

Change-Id: I96ef285dfa6624ca8bee79f2ec508eb2f9ff25b1
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2019-09-24 17:27:09 +01:00
Stephen Finucane 0cae0bc84e Fixups for pdf docs
- Don't remove badges - simply exclude them from the main docs.
- Don't include stuff that only makes sense in HTML - namely the indexes
- Don't explicitly set basepython in a tox testenv when we can inherit
  it

Change-Id: Ib3db3888d0bb1c47773e3e44919c7077d0906ceb
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2019-09-24 17:26:39 +01:00
Chris Dent 99d879abfd Build pdf docs
This follows the instructions [1] in an attempt to build pdf docs.

To get a build, the "badge" in the README has been removed.
The other option to add some svg -> pdf support, but that seems
overkill for a badge which is effectively meaningless.

The build wanted 'xindy' to build an index, but we can turn that
off and still get useful results.

[1] https://etherpad.openstack.org/p/train-pdf-support-goal

Change-Id: Icf7c22bf9d1de6fb2a74a756c370930d4c00b0b9
Story: 2006110
Task: 35397
2019-09-11 16:21:06 +01:00
melanie witt 51c0064f51 Cap sphinx for py2 to match global requirements
This is necessary to get the requirements-check job to pass.

Taken from the following openstack/requirements change:

  I9a22fd842cdea8dcda1900def51ad403d8bae9e8

Change-Id: I07680578feb8814eb6343e55ce4177771ed2c93f
2019-08-28 21:01:47 +00:00
Andreas Jaeger f40eb5047a Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: Ib9e2658f123e1d4a12261f54cf91415c2c339dda
2019-07-25 18:08:33 +02:00
Chris Dent 6a87214002 Remove unused cruft from doc and releasenotes config
The conf.py files had a lot of noise in them that isn't used.
This patch trims it back.

Change-Id: I5cfacdd052332c69e67bd27243f46163a09ceffe
2019-04-05 14:36:58 +01:00
Chris Dent dbd50cbf97 Use openstackdocstheme instead of oslosphinx
The latter does not work well with Sphinx 2.0.

Switching brings us up to date with modern norms. The
changes made here are to get it working:

* Changing tox jobs to the modern style, with a separate
  requirements.txt in the doc directory.

* Updating doc and releasenotes conf.py to use the new
  theme and correctly point at storyboard for bugs

* Remove docs related requirements from test-requirements.txt

Change-Id: I9770f375b0fd7a6cacdd02e3d0381a28879f18b5
2019-04-05 11:41:52 +01:00
Zuul 5a98631dbb Merge "Resource provider examples" 2018-08-29 14:26:42 +00:00
Andrey Volkov 577eec26c5 Resource provider examples
Adds examples the resource provider CLI for version 1.0.

Change-Id: Id33fea47b21d8697fb163b3ccb589ad3dae340ae
2018-07-12 12:17:33 -04:00
Stephen Finucane cc0dd67651 Resolve nits from I552688b9ee32b719a576a7a9ed5e4d5aa31d7b3f
Some of the options are just noise. Hide them.

Change-Id: Iac625137386de071d0f95f94bd37a3884ebe1eaf
2018-03-22 16:34:43 +00:00
Matt Riedemann 5b39d446be Usage docs and initial release note for osc-placement
This adds the initial usage docs and a release note for the
first set of commands available in what will be the 1.0.0
release for the osc-placement plugin in the Queens series.

There are some other changes to the docs layout:

* The cliff.sphinxext is used to get the CLI reference.
* The README is inlined to the top docs index page.
* The usage doc is changed to the user/index.rst format
  based on the docs.o.o manuals migration spec.
* The ordering of the contents is also changed based on
  the docs.o.o manuals migration spec.
* The modindex is removed since it doesn't exist and since
  there are no python API bindings in this library, we don't
  need a module index anyway.

Depends-On: Id18aab2a95849bc60769f2f81c363c17d049b21f

Part of blueprint placement-osc-plugin

Change-Id: I552688b9ee32b719a576a7a9ed5e4d5aa31d7b3f
2018-01-24 11:51:54 -05:00
Roman Podoliaka 2c538f3ea0 Initial commit
- import coockiecutter template
- set up basic testing
- implement interface of an OSC plugin
2017-03-22 11:58:28 +02:00