Commit Graph

10 Commits

Author SHA1 Message Date
Terry Wilson 6f7aed7098 Add some basic usage documentation
This adds some basic usage documentation and a simple tutorial for
ovsdbapp.

Change-Id: I19583b439f0d8488e957265d89309abf08d307e7
2023-07-18 16:57:27 -05:00
shanyunfan33 b45267fc5c remove unicode from code
remove unicode from code

Change-Id: I18c124a5dccba6b1f3868ca297e23d1e96acbf8c
2021-12-24 14:48:33 +08:00
Andreas Jaeger ac54f148f0 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.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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: Idfea423764768d5a35c8b5b8f73286cd4a19a974
2020-05-25 13:33:41 +00:00
Akihiro Motoki 8bfddd3c1c PDF documentation build
README.rst and doc/source/index.rst are modified a bit
to fit both HTML and PDF docs.

Change-Id: I128a45eddfe9de06c4961555ddd79a62723338c1
Story: 2006099
Task: 35138
2019-09-05 09:17:29 +02:00
Andreas Jaeger ac3d3de9ec Update Zuul jobs: Enable docs publishing
Start publishing docs with using the proper template.

For this, add also a doc/requirements.txt file and move docs
requirements there. Update tox.ini for this and use the modern way to
invoke sphinx-build for building.
Remove obsolete sectoins from setup.cfg.
Update the conf.py files and remove unused lines
with newer openstackdocstheme - and require newer theme.

Fix indents in CONTRIBUTING.rst so that the formatting works nicely.

Also, use lower-constraints template instead of individual jobs.

Change-Id: Ia1a7030878f12ca0b8184363173eada929ece3bd
2019-09-05 09:17:05 +02:00
caoyuan bcafa4bf3e Update the UPPER_CONSTRAINTS_FILE for tox
1. Update the UPPER_CONSTRAINTS_FILE for tox[1]
2. Remove unncessary "=="
3. Update some URLs to latest

[1]: http://lists.openstack.org/pipermail/openstack-discuss/2019-May/006478.html

Change-Id: I447fa8594a7f11d5d8ed455353020b6871f596e5
2019-06-27 20:40:14 +08:00
Arundhati Surpur 7f1c66e01f Removes unnecessary utf-8 encoding
This patches removes unnecessary utf-8
encoding in doc/source/conf.py

Change-Id: I19ecb9c37e737c7e94a39c1d6ec21f4f25e929d3
2017-07-20 16:35:33 +05:30
Akihiro Motoki 805d613ec9 rearrange existing documentation to fit the new standard layout
Part of doc-migration work. For more detail, see:
https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
https://etherpad.openstack.org/p/doc-migration-tracking

Change-Id: I545f16d6fe1fd3c2ed76f71b0ff79f93f3a1996e
2017-07-08 17:30:46 +00:00
Akihiro Motoki 3c24077c8f Switch from oslosphinx to openstackdocstheme
Part of doc-migration work. For more detail, see:
https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
https://etherpad.openstack.org/p/doc-migration-tracking

Change-Id: I3dd0e0eda89516228ff1eead861455920a916845
2017-07-08 17:30:46 +00:00
Terry Wilson 81e6bf5393 Add cookiecutter output 2017-02-24 15:02:19 -05:00