Commit Graph

6 Commits

Author SHA1 Message Date
Andreas Jaeger 84b9989a79 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.

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: I9843c6b66d4411857cb19c5d176d39b200423257
2020-05-31 17:56:34 +02:00
Goutham Pacha Ravi d3e3d1b8a9 Switch to openstackdocstheme
Provides consistency across other specifications
on specs.openstack.org.

Change-Id: Ibcdba4fe820193b1594f36cef6c31c24005bd464
2018-04-27 13:27:29 -07:00
zhongjun d5dc5b51fa Fix sphinx version to !=1.6.1,>=1.5.1
Since then the jenkins job of gate-manila-specs-docs-ubuntu-xenial
always failed. Let's set sphinx version to !=1.6.1,>=1.5.1 to fix
the failure in test-requirements. As the same as manila project does.

https://review.openstack.org/#/c/465263/2/test-requirements.txt.

Partial-Bug: #1691622
Change-Id: Ic411bb789deaf3b71c4b94d465dd673d6f5cfd5e
2017-05-20 01:56:40 +00:00
Tom Barron 0a09001e5b Add support for blockdiag
and its family of diagrams [1]: blockdiag, actdiag, seqdiag,
and nwdiag.

These enable block, sequence, activity, and logical network
diagrams, defined in a simple text format, and with this patch
can be easily embedded in our specs.  For examples, see [2].

[1] http://blockdiag.com
[2] https://specs.openstack.org/openstack/neutron-specs/specs/juno-incubator/example.html

Change-Id: I999d8f5211266c4ce6d991ff92fe73e3843b5596
2017-04-14 10:15:52 -04:00
Tom Barron 3c669be677 Update tox.ini to align with other manila repos
so that we can run 'tox' locally and properly validate our spec
docs.

* Update tox minversion and requirements
* Clean out build directory before new docs build
* Run doc8 validation
* Fix numerous incidental errors in the specs and templates
  so that doc8 now passes
* Setup both py35 and py27 environments
* Turn off yasfb extension until it can work with python 3

Change-Id: I722a9ad852cdfa0974322fbe29db37956dab3ee0
2017-04-13 20:21:54 -04:00
Ben Swartzlander 34524720d1 Create skeleton using cookiecutter
This repo skeleton was created using the openstack
specs-cookiecutter.

Change-Id: I180f61555c2aeeaf96ff17d568b6958a26d5e75e
2016-05-12 14:51:16 +00:00