Commit Graph

11 Commits

Author SHA1 Message Date
niuke d7d956a7c1 remove unicode prefix from code
Change-Id: I107d7e7c6c86775707670d8fdfbfd0e7c0e17bff
2022-08-23 18:27:07 +08:00
Andreas Jaeger 84d6c4ffc9 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.

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.

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: I9dfa47d28d3f76115d6cf6dd86ea04d621d99c65
2020-05-25 15:36:09 +02:00
Dmitry Tantsur 7fd83d7d9b Dependencies and tox.ini clean-up
* Remove testscenarios, it's an ancient artefact
* Replace the only usage of testtools with a simple check
* Split out doc/requirements.txt
* Clean tox.ini of unnecessary (and probably cargo-culted) stuff
* Added Pygments for syntax highlighting check

Change-Id: I9f6b03606973e1e8123165c46bef53c4ce8e2b92
2020-04-28 13:20:08 +02:00
Andreas Jaeger a235a15346 Cleanup py27 support
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 apidoc instead of autodoc for API docs, use sphinx-build.

Change-Id: Ie6107bc80961a7306957b17ac2eda44417b53d3e
2020-04-05 19:16:10 +02:00
Kaifeng Wang aa44aadb72 Build pdf doc
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

TeX packages are required to build PDF locally, following is recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems

Change-Id: I8b42ab0f057cb33c1ec93adfa32c45aafc2730b0
2019-09-06 08:45:32 +08:00
howardlee 598ccc0eca Update and replace http with https for doc links
1) Update doc links according to OpenStack document migration
2) Use https instead of http for docs links

Change-Id: Icf10fb8f00c49bc9027212501e2fa59becfc3a1c
2017-07-21 16:40:32 +08:00
Julia Kreger 6678a9d9c6 Rework base landing page to contributor docs
Change-Id: I1fea1922376f5dcb1c1efa2da20e33c82ba64d2d
2017-07-19 13:33:02 +00:00
Julia Kreger 958063e1ed Switch from oslosphinx to openstackdocstheme
Change-Id: I52055e7b3c0ed8f56d05ca624339b7e9aca19222
2017-07-15 14:39:36 +00:00
Yushiro FURUKAWA 813c727b19 Use 'code-block' for pieces of code
'code-block' improves the visibility for the pieces of code.

Change-Id: I163e3ad625f3d86b75fdf208aae526b694884dc1
2016-10-06 15:35:57 +09:00
Jay Faulkner 7aff4e1689 Add developer documentation on metrics
Adds developer documentation to ironic-lib index page about how to emit
metrics and what each metric type is useful for.

Change-Id: I3e835717aa141f0e0fa0f026b910b9a9ed60665e
Partial-bug: #1611559
2016-08-19 08:49:33 -07:00
Jay Faulkner 4f58317ce0 Add framework for doc building in ironic-lib
This adds a doc build for ironic-lib. Currently the only documentation
is that generated from docstrings.

Change-Id: I6ee00ad863bc7ce72958db4e8d5b6871a5b96eb0
Partial-bug: #1614272
2016-08-18 09:14:52 -07:00