openstack/nova
Code Issues Proposed changes
acdb72bfac
nova/doc/source/index.rst

211 lines
6.0 KiB
ReStructuredText
Raw Normal View History

initial commit
2010-05-27 23:05:26 -07:00
..
Removes RST documentation and moves it to openstack-manuals Avoiding redundant information and confusion. Change-Id: Iab1913ff359699db977b74554bad6088fab6ab2f
2012-04-30 12:45:10 -05:00
Copyright 2010-2012 United States Government as represented by the
Remove trailing whitespaces in regular file Fixes bug #945346 Change-Id: I07a303c2e503e50d7138585c683e0d1310339276
2012-03-07 13:43:37 +08:00
Administrator of the National Aeronautics and Space Administration.
Updated licenses
2010-06-23 22:04:16 -07:00
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
initial commit
2010-05-27 23:05:26 -07:00
http://www.apache.org/licenses/LICENSE-2.0
Updated licenses
2010-06-23 22:04:16 -07:00
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
initial commit
2010-05-27 23:05:26 -07:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
==========================================
Removes RST documentation and moves it to openstack-manuals Avoiding redundant information and confusion. Change-Id: Iab1913ff359699db977b74554bad6088fab6ab2f
2012-04-30 12:45:10 -05:00
Welcome to Nova's developer documentation!
==========================================
initial commit
2010-05-27 23:05:26 -07:00
Cleanup docs landing page Our docs our wildly out of date and pretty bad, this is a first step at beginning to clean them up and make them more useful. * remove the guidelines section. 2 of them are explicitly wrong (API Compatibility and Open Standards), and no one actually uses these guidelines during development. Yes we want high availability and fault tolerance, but listing these design guidelines here is misleading at best. * Don't explain how this document is built, don't need to explain that so prominently * Update the intro based on Nova's mission statement Change-Id: Ia564a7cacdac0ddab913464ca1c7f9fefb0ee0b5
2015-05-01 19:21:58 -07:00
Nova is an OpenStack project designed to provide power massively scalable, on
demand, self service access to compute resources.
New structure for documentation.
2010-10-27 00:05:42 -04:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
The developer documentation provided here is continually kept up-to-date
based on the latest code, and may not represent the state of the project at
any specific prior release.
Add note to doc explaining scope This is developer oriented documentation, make sure that is clear and point to docs.openstack.org for more docs. Change-Id: I0680e331b0fcf57dddb157c99e59d690fea349cb
2015-05-13 12:34:40 -07:00
.. note:: This is documentation for developers, if you are looking for more
general documentation including API, install, operator and user
guides see `docs.openstack.org`_
Fix a couple dead links in docs The docs had references to https://docs.openstack.org but this website is http only. Connecting to the https address results in an unable to connect error. Replacing with http also makes it consistent with all other references to docs.openstack.org. Change-Id: I5367bb623aff33148cceadbdcb8df3550f655ed4
2015-08-04 22:03:51 -07:00
.. _`docs.openstack.org`: http://docs.openstack.org
Add note to doc explaining scope This is developer oriented documentation, make sure that is clear and point to docs.openstack.org for more docs. Change-Id: I0680e331b0fcf57dddb157c99e59d690fea349cb
2015-05-13 12:34:40 -07:00
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
This documentation is intended to help explain what the Nova developers think
is the current scope of the Nova project, as well as the architectural
decisions we have made in order to support that scope. We also document our
plans for evolving our architecture over time. Finally, we documented our
current development process and policies.
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
Compute API References
Changes conf.py for Sphinx build because oslosphinx now contains GA - Changes api to API to force build of all source files. - Ensures tracking is consistent across all openstack.org web properties. - Tracks only docs.openstack.org/developer/{{ project }} where project name is taken from conf.py. - Removes ability to build local without GA. If you have ideas for how to build local without GA, please patch. Change-Id: Ibb61e5c1668e6a0782daf91d4faf0950c5bf77d7 Partial-bug: 1441315
2015-04-09 12:40:04 -05:00
======================
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
Nova has had a v2 API for a long time. We are currently in the process of
moving to a new implementation of that API, which we have called v2.1. v2.1
started life as an API called v3, but that name should never be used any more.
We are currently in the process of transitioning users over to the v2.1
implementation, at which point the v2 code will be deleted.
Add note to doc explaining scope This is developer oriented documentation, make sure that is clear and point to docs.openstack.org for more docs. Change-Id: I0680e331b0fcf57dddb157c99e59d690fea349cb
2015-05-13 12:34:40 -07:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
* `v2.1 (CURRENT)`_
* `v2 (SUPPORTED)`_ and `v2 extensions (SUPPORTED)`_ (Will be deprecated in
the near future.)
modifications and additions based on doc sprint
2010-11-11 11:07:47 -08:00
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
Changes to the Compute API post v2.1 are made using microversions. You can see a history of our microversions here:
Link to microversion history in docs Make the API microversion history more accessible by adding it to nova's doc landing page. Making sure it is easy to discover what the difference between each microversion is fundamental piece of the microversion puzzle, so lets not require end users to have to look through git. rename api_microversions.rst to api_microversion_dev.rst to clarify that it is about development and versus history. Change-Id: I270944bf9739b113a43b932948fdbf83e449603b
2015-06-10 18:31:58 +03:00
.. toctree::
:maxdepth: 1
api_microversion_history
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
We also have a local copy of the v2 docs:
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
.. toctree::
:maxdepth: 1
v2/index
.. _`v2.1 (CURRENT)`: http://developer.openstack.org/api-ref-compute-v2.1.html
.. _`v2 (SUPPORTED)`: http://developer.openstack.org/api-ref-compute-v2.html
.. _`v2 extensions (SUPPORTED)`: http://developer.openstack.org/api-ref-compute-v2-ext.html
Hypervisor Support Matrix
=========================
initial commit
2010-05-27 23:05:26 -07:00
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
The hypervisor support matrix is how we document what features we require
hypervisor drivers to implement, as well as the level of support for optional
features that we currently have. You can see the support matrix here:
initial commit
2010-05-27 23:05:26 -07:00
.. toctree::
New structure for documentation.
2010-10-27 00:05:42 -04:00
:maxdepth: 1
Add formal doc recording hypervisor feature capability matrix Add document to replace / obsolete the giant table on https://wiki.openstack.org/wiki/HypervisorSupportMatrix This initial draft is a fairly straightforward conversion of that table. Over time, it needs much work to improve the coverage of API operations and and coverage of important configuration information that users will care about. It is using the .ini file syntax in order to record the data in an easily machine parsable format, while remaining human friendly by avoiding the syntax heavy approach of XML / JSON / YAML An extension is registered with sphinx that can convert the .ini file content into docutils content that then gets rendered into the developer docs, linked from the index page Change-Id: I4d3db4bce5737dba30a026a11083a9ea64459cd4
2014-11-21 14:57:07 +00:00
support-matrix
additions to home page
2010-11-05 11:56:12 -07:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
Developer Guide
===============
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
If you are new to Nova, this should help you start to understand what Nova
actually does, and why.
Adds Compute API v2 docs Imported from public API docs plus fixes to make them more accurate. Change-Id: I6d5ba6b96772e0f17fc7484312222110ec103bbf
2014-12-17 10:14:37 -06:00
.. toctree::
:maxdepth: 1
docs: add a placeholder link to mentoring docs Adding docs to make it clear how to get more involved. As a first step, lets link to the docs we are working on in the wiki. At a later date we can graduate the wiki docs into here. blueprint devref-refresh-liberty Change-Id: If6c24bc4522eab72354c1602ceaa07352104a34d
2015-07-09 13:30:52 +01:00
how_to_get_involved
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
architecture
project_scope
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
development.environment
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
Development Policies
--------------------
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
The Nova community is a large community. We have lots of users, and they all
have a lot of expectations around upgrade and backwards compatibility.
For example, having a good stable API, with discoverable versions and
capabilities is important for maintaining the strong ecosystem around Nova.
Remove jenkins, launchpad and gerrit docs All of that information can be found at http://docs.openstack.org/infra/manual/developers.html, so just make the link to developers.html more prominent in development.environment * Rename development.environment to a shorter title, Developer quickstart. Change-Id: I1460e6c86a7e0a1efb4a81c6c5cb594476171214
2015-05-14 14:57:54 -07:00
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
Our process is always evolving, just as Nova and the community around Nova
evolves over time. If there are things that seem strange, or you have
ideas on how to improve things, please engage in that debate, so we
continue to improve how the Nova community operates.
This section looks at the processes and why. The main aim behind all the
process is to aid good communication between all members of the Nova
community, while keeping users happy and keeping developers productive.
Adds Compute API v2 docs Imported from public API docs plus fixes to make them more accurate. Change-Id: I6d5ba6b96772e0f17fc7484312222110ec103bbf
2014-12-17 10:14:37 -06:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
.. toctree::
:maxdepth: 1
Adds extension documentation for some but not all extensions Change-Id: I187483ccacd9c29c1c414fbf8481ead23f9c457a
2011-12-02 13:02:06 -06:00
docs: add a placeholder link to mentoring docs Adding docs to make it clear how to get more involved. As a first step, lets link to the docs we are working on in the wiki. At a later date we can graduate the wiki docs into here. blueprint devref-refresh-liberty Change-Id: If6c24bc4522eab72354c1602ceaa07352104a34d
2015-07-09 13:30:52 +01:00
process
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
blueprints
policies
Architecture Concepts
----------------------
This follows on for the discussion in the introduction, and digs into
details on specific parts of the Nova architecture.
We find it important to document the reasons behind our architectural
decisions, so its easier for people to engage in the debates about
the future of Nova's architecture. This is all part of Open Design and
Open Development.
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
.. toctree::
:maxdepth: 1
aggregates
threading
vmstates
i18n
filter_scheduler
rpc
hooks
Add documentation for block device mapping This commit adds some (long overdue) documentation around block device mapping and how it's used in Nova. blueprint devref-refresh-liberty Change-Id: Idca142f3b34ad896ab99f02a3f9eb72a6a3b4778
2015-06-17 14:02:39 +01:00
block_device_mapping
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
addmethod.openstackapi
Architecture Evolution Plans
-----------------------------
The following section includes documents that describe the overall plan behind
groups of nova-specs. Most of these cover items relating to the evolution of
various parts of Nova's architecture. Once the work is complete,
these documents will move into the "Concepts" section.
If you want to get involved in shaping the future of Nova's architecture,
these are a great place to start reading up on the current plans.
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
.. toctree::
:maxdepth: 1
docs: clear between current vs future plans Reorganized the developer docs so its clear between whats are future plans and what things are documenting the current behavior. Given a lot of the API docs are currently in flux, I have classed those as future plans. blueprint devref-refresh-liberty Co-Authored-By: Michael Still <mikal@stillhq.com> Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
2015-06-16 14:37:16 +01:00
cells
upgrade
api_plugins
api_microversion_dev
policy_enforcement
stable_api
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
Advanced testing and guides
----------------------------
.. toctree::
:maxdepth: 1
gmr
testing/libvirt-numa
testing/serial-console
Man Pages
----------
.. toctree::
:maxdepth: 1
man/index
Module Reference
----------------
.. toctree::
:maxdepth: 1
Corrects link to API Reference on landing page Point directly to the document being referenced, instead of the API documentation site. Change-Id: I7796d6a53ed0f21a5873202dfdc50d456325d70f
2014-12-03 15:57:19 -06:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
services
Adds extension documentation for some but not all extensions Change-Id: I187483ccacd9c29c1c414fbf8481ead23f9c457a
2011-12-02 13:02:06 -06:00
Set autodoc_index_modules=True so tox -e docs builds module docs again Commit bd7e62f796fe951fd42c2edad56e252a0b7393c8 disabled the autodoc_index_modules flag for building docs but it wasn't really necessary, that change was just to get the module index out of the main docs page. We want to autodoc the modules so we can view the actual module index in the tox -d docs build results, which also tells us if we have correct ReST format in doc strings. Notes ----- 1. Several doc string blocks have to be fixed as part of this to get the docs tox job to pass. 2. A docstring in vhdutilsv2 is updated to remove the math directive since that requires the sphinx.ext.pngmath extension which requires latex and dvipng packages from the distro - which is overkill for what the docstring was actually doing with the math directive. 3. We exclude autodoc for tests since we don't really care about docstrings on unit tests. 4. We exclude the nova.wsgi.nova-* modules since those won't build with autodoc since they can't be imported (there is no nova/wsgi/__init__.py module). We could arguably add the __init__.py but it's not really necessary for what those scripts are used for. 5. The sphinx.ext.ifconfig extension is removed since there are no docs that use the ifconfig directive. 6. Update the developer docs to explicitly point out that graphviz must be installed prior to running tox -e docs. 7. Hide doc/source/api/autoindex.rst from the toctree so that we don't regress the point of commit bd7e62f796fe951fd42c2edad56e252a0b7393c8. 8. unused_docs and exclude_trees options are removed from conf.py since they are deprecated in Sphinx 1.2.3: https://github.com/sphinx-doc/sphinx/blob/1.2.3/sphinx/config.py#L54 9. Fix imports for moved libvirt volume options. Closes-Bug: #1471934 Change-Id: I946e2f89f2c9fc70e870faaf84e4a8b0fc703344
2015-07-06 15:18:59 -07:00
.. # NOTE(mriedem): This is the section where we hide things that we don't
# actually want in the table of contents but sphinx build would fail if
# they aren't in the toctree somewhere. For example, we hide api/autoindex
# since that's already covered with modindex below.
.. toctree::
:hidden:
api/autoindex
initial commit
2010-05-27 23:05:26 -07:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Copy Permalink