23 Commits

Author SHA1 Message Date
Jenkins
49c21196bc Merge "doc-migration: new directory layout" 2017-08-26 04:28:12 +00:00
Jenkins
5ec71a315e Merge "doc migration: openstackdocstheme completion" 2017-08-26 04:28:06 +00:00
Tom Barron
6785f07e7b doc-migration: new directory layout
This patch introduces a new directory layout
in doc/source in conformance with the OpenStack
manuals project migration spec [1], moves the
existing content in manila/doc/source into the
new directories, and adjusts index files accordingly.

This is the first step in the migration process
as outlined in the spec.

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Closes-Bug: #1706181
Change-Id: I8964d066bb838fabbe94239ac108bff884c6ff76
Depends-On: I72be6303f9be77c0461eaacbc61bad8372546fb5
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
2017-08-24 23:58:16 -04:00
junboli
767cfa6723 Add license to doc/source/conf.py
TrivialFix

Change-Id: I80f4c5373997077e4524c4efbbe6c10c5540b7a1
2017-08-22 08:36:53 +00:00
Tom Barron
f98e4f6723 doc migration: openstackdocstheme completion
This patch completes the transition from oslosphinx
to openstackdocs theme in accord with the OpenStack
manuals project migration spec [1].

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I72be6303f9be77c0461eaacbc61bad8372546fb5
Partial-Bug: #1706181
Needed-By: I8964d066bb838fabbe94239ac108bff884c6ff76
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
2017-08-21 10:32:53 -04:00
howardlee
450b093e64 Replace http with https
Trivialfix

Change-Id: Ia12e0afb5bc42d7fd0ff3638d5add23733f8d369
2017-07-19 18:56:26 +08:00
luke.li
7378896225 Switch from oslosphinx to openstackdocstheme
Use the new style of setting of openstackdocstheme according to follow.
https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: I67b7082d9a21f39cb5b62b753f39dd56f81860cb
2017-07-06 16:27:45 +08:00
Stephen Finucane
2b97ead879 doc: Remove cruft from conf.py
Change-Id: Idfd0b9fe9def7792f9fda9d035fd4ce5ed2a67b9
2017-04-19 10:41:50 +01:00
Stephen Finucane
e19b787dd4 Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Enable this.

Change-Id: I8ea73cff6dc539c9f9db2f550ad8088812467d1b
2017-04-19 10:41:19 +01:00
melissaml
31cd7b16b1 Removes unnecessary utf-8 encoding
The following file(s) added utf-8 encoding but never used. So we can
remove them at all.

doc/source/conf.py
releasenotes/source/conf.py

Change-Id: I8ffd8ad1a9638a80696c3d0775372de5be642fbc
2017-01-05 15:07:57 +08:00
vponomaryov
60b7c5caea Fix view of doc info for functional tests
Format text for functional tests so it could be interpreted properly.

TrivialFix

Change-Id: I96d624de23993554d1515b85f2e4e1c6b6ab604d
2016-05-17 18:00:51 +03:00
Joe Gordon
281795ef75 Drop incubating theme from docs
OpenStack has dropped the incubation notion, so labeling this as an
incubated project in the docs is confusing.

Change-Id: I9f9c70f9d6fd9156da66280183fa933f72b59d7a
2015-05-27 15:25:02 -07:00
vponomaryov
a05a48b59c Add info about functional tests run to docs
Make doc with tests description up-to-date and provide there information
that describes how to run functional tests.

Partially implements bp functional-tests

Change-Id: Iad6b1d97a9c43dd24c2c6837bb71739a6f09bb1e
2015-01-14 15:41:28 +00:00
Jenkins
35fc635556 Merge "Add manila cli help output to doc" 2014-12-12 19:39:38 +00:00
Thomas Bechtold
4faae5a7b8 Add manila cli help output to doc
Dynamically generate the cli help output and include
it into the documentation.

Change-Id: Ib56c8b28272f955924c80f0a893de71a62fc5b49
2014-12-11 23:58:54 +01:00
Jeremy Stanley
8f135629cd Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: Ib50f0ff10da76e53a9b4545a1007e5425d39fd94
2014-12-05 03:30:40 +00:00
Andreas Jaeger
dc4d63e86c Improve documentation
Split up index page, remove duplicated shell information, include
other exiting files and the usual indices and tables.

Change-Id: I271c245c9d3af81e4563c489f7a5fd279fd1568e
2014-11-11 18:17:13 +01:00
Andreas Jaeger
af8a53d087 Use oslosphinx
Since manila is now an incubated project, use oslosphinx together with
the incubated theme.
Unset html_static_path since there's currently no static file and sphinx
warns otherwise.

Change-Id: Icfbf2c0ee214da870c3c711a34b6a649e9878659
2014-09-22 21:51:29 +02:00
Andreas Jaeger
9b99c92c6d Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Closes-Bug: #1368910
2014-09-13 13:13:18 +00:00
Valeriy Ponomaryov
fc658dd932 Update manila docs
After manila's fork from cinder, its docs were not
updated well.

Partially implements: blueprint manila-documentation

Change-Id: Idcf611ff08a9c7fdad1c87714444579eac85e479
2014-06-17 11:01:29 -04:00
Yulia Portnova
77dffa2c99 mass replace cinder to manila 2013-09-05 13:32:38 +03:00
Yulia Portnova
fa125b7714 setup.py fixed 2013-09-03 14:37:34 +03:00
Ben Swartzlander
5e9ada9fc6 Initial checkin 2013-09-02 23:42:41 -04:00