Commit Graph

4 Commits

Author SHA1 Message Date
Martin Chacon Piza 91022f3e80 Remove project content on master branch
This is step 2b of repository deprecation process as described in [1].

[1] https://docs.openstack.org/project-team-guide/repository.html#step-2b-remove-project-content

Change-Id: Ie446c1cd447789d189a9e723fff9ee783dd3cf4f
2021-02-22 14:57:15 +01:00
Andreas Jaeger a8d2c2e2da 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.

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: Id0886a73e1bd1c8a30dd7d1f50af7c7eab90d916
2020-05-22 16:30:30 +02:00
Tomasz Trębski d14e2abc17 Configuration documentation
Commits fills in the documentation part that touches
configuring monasca-log-api. With this documentation one
can learn about possible ways and options needed to
have own monasca-log-api properly configured.

Story: 2001058
Task: 4783

Change-Id: I8ae3531fff6d70450b187a4945ce68c472db63b6
2017-07-24 11:07:47 +00:00
Tomasz Trębski 29126ba9f8 Migrate documentation to Sphinx
Migration of Openstack Project is held in
*.rst files and build with Sphinx.

Following change provides:
* technical documention
* api guide
* api ref
* releasenotes

Note:
    For now, generating codebase documentation is disabled.
    It caused gate failures because of, yet unnown, reasons.
    In order to pull this foundation, this part is skipped.

Extra:
* provided venvs descriptions to let user know what is the scope

Story: 2001058
Task: 4665

Change-Id: Ieb2b58e165de1617748d97d997af368bd91d5c0e
2017-07-03 07:38:53 +00:00