13 Commits

Author SHA1 Message Date
Mark Goddard
c9cc6f4064 docs: add variable for current branch
This allows us to include the correct branch when cloning repositories
in documentation.

Method adapted from OpenStack Ansible documentation. A backslash is
added on purpose before repository URLs to bypass highlighting which
makes them less readable (dark text on dark background).

https://opendev.org/openstack/openstack-ansible/src/branch/master/doc/source/conf.py

Story: 2008851
Task: 42366
Change-Id: I4b4a8d1c848bb992f65860b058cb9fd9d77613d0
2021-06-09 14:01:13 +02:00
Mark Goddard
7f7c4e2a48 Add documentation for routed control plane networks
Kayobe currently supports definition of various different networks -
public, internal, tunnel, etc. These typically map to a VLAN or flat
network, with an IP subnet. When a cloud exceeds the size of a single
VLAN/subnet, this approach no longer works.

One way to resolve this is to have multiple subnets that map to a single
logical network, and provide routing between them. This is a similar
concept to neutron's routed networks, but for the control plane.

This change provides documentation for the currently tested parts of
this feature.

Change-Id: Ic06c6d4fff0fa568eb9ed3a9c30ce21c7699d965
Story: 2008180
Task: 40938
2021-02-03 12:08:46 +00:00
Mark Goddard
354113c20b docs: Move configuration reference to subpath
This allows us to add configuration scenarios.

Change-Id: Id636f78c61237fb27fa65fa3d4b3fc1a4cf0ba6a
Story: 2004360
Task: 40777
2020-08-28 08:28:40 +01:00
Andreas Jaeger
87c91cc615 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.

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: Ic10edb7103455b477cece3940f150f4345611562
2020-06-11 17:22:05 +00:00
gugug
233c10d1b0 Fix pygments style
Change-Id: Ie15aa810538ecfdc8293dc0eda0610d82587fddd
2020-05-20 00:57:02 +00:00
chenxing
b41311f128 Docs: show other versions
Change-Id: I9bc19aa9dcea6dad242d93cecfb4f201ae855463
2020-02-11 19:23:39 +08:00
Andreas Jaeger
d5a3c74b16 Update docs building
* Use storyboard instead of launchpad since this project uses
  storyboard. This fixes the "Report a bug" link.
* Remove unneeded configuration bits for doc building, the
  defaults of openstackdocstheme are fine.

Change-Id: Id7513b245d1b4eac09f717a7f47469fd7bb4d3b5
2020-01-30 09:40:39 +01:00
Mark Goddard
8c01771e29 Add documentation for Bifrost and IPA configuration
Depends-On: https://review.opendev.org/690559/

Change-Id: I4e766424607317e5817d26461f7a1e180e9b2146
Story: 2004337
Task: 37378
Task: 37381
2019-11-25 13:42:21 +00:00
Mark Goddard
798b7dfc53 Build pdf doc
The is one of community goals that each project should 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: Ib8a238f5ad4329527147be72331b87f57877f68e
2019-10-16 14:36:13 +01:00
Mark Goddard
7321205c06 Update docs after repo rename x/ to openstack/
Depends-On: https://review.opendev.org/669298
Change-Id: Ia4138179132d3a284b0c4bcc882b87bde22c9cc4
2019-09-16 17:39:29 +01:00
Mark Goddard
c44f27b4ae Move to openstackdocstheme for docs & release notes
Sphinx configuration adapted from kolla ansible.

Change-Id: Ibcfbd9114a099d8b487f543d526b0cde0744d84a
2019-08-03 19:02:20 +01:00
Mark Goddard
7807016862 License kayobe project under Apache2
All python files now have a license header and copyright notice
2017-04-06 10:15:29 +01:00
Mark Goddard
61f7f804cb Expand documentation and change to sphinx from MarkDown 2017-03-29 14:02:51 +01:00