10 Commits

Author SHA1 Message Date
Akihiro Motoki
6c0e4d7a39 PDF documentation build
Also reorganizes the document structure to match both HTML and PDF docs.

Story: 2006100
Task: 35143

Change-Id: Ie3f38e2ecf52e6a6cbd52bb36196e6f589f1ca0f
2019-10-11 03:51:38 +09:00
Takashi NATSUME
763898687d Fix duplicate object description error
Add a directive option flag :noindex:
in reference/api/index.rst.

Change-Id: Ifa5cf9820be29f498c218105272837cac50cb643
Closes-Bug: #1833327
2019-06-19 11:33:15 +09:00
Takashi NATSUME
fe4138aea4 Updates for OpenDev transition
Replace 'git.openstack.org' with 'opendev.org'
in contributor/index.rst.
Update URLs in other places as well though there are redirects.

See the following URLs for more details:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Change-Id: Ifb9f4274d2fd0fa81e7501fe176eeead3acd0e3e
2019-04-23 01:18:31 +00:00
Takashi NATSUME
0fdb154d9c doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: I3b9db8b71c082dd5f8d0564a9cdfdb2fa6dc5ed6
2018-10-09 12:22:17 +09:00
Takashi NATSUME
9d8eda8b82 Follow the new PTI for document build
- Follow new PTI for docs build
- Add sphinxcontrib.apidoc to replace pbr autodoc

REF:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: Ic66fe4d5488c7777439a416fbf86d37af807804d
Closes-Bug: #1792115
2018-09-13 04:57:03 +09:00
Takashi NATSUME
be94318add Replace GB with GiB
In documents and comments, 'GB' (gigabyte) is used.
Strictly 'GiB' (gibibyte) should be used.
So replace 'GB' with 'GiB'.

Change-Id: Ic03f202d4fe357bc6400275abdccd4b37521f4a3
Closes-Bug: #1521791
2018-04-04 00:08:52 +00:00
Jenkins
de8bb757dd Merge "Remove custom autodoc implementation" 2017-08-01 16:33:41 +00:00
Takashi NATSUME
561b35a8a8 Update URLs in docs, comments and setup.cfg
Some URLs are broken, so fix them.
The other URLs are redirect to new URLs,
so replace them with new ones.

Change-Id: Ida2fd70ad0d7b029fadfe91be14d7180b9b5b8d1
Closes-Bug: #1707104
2017-07-28 12:14:12 +09:00
Stephen Finucane
437b08cf38 Remove custom autodoc implementation
pbr provides this functionality for us. Make use of it.

Change-Id: Ide7b2992ac931395b776d39ed4a1a50bded0a881
2017-07-12 15:13:04 +01:00
Stephen Finucane
e11efd8d76 doc: Create directory structure for docs migration
The spec [1] recommends the following sections:

- install
- contributor
- configuration
- cli
- admin
- user
- reference

Only a few of these are useful here:

- contributor
- cli
- user
- reference

Add these and populate them.

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

Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-12 15:07:35 +01:00