* Removing openSUSE 13.1 and adding openSUSE 42.1 (LEAP).
* Removing Factory as its called as Tumbleweed now.
Change-Id: Iea26ac4ea343b63bc07cdf9fef0659a2887fe584
Post Ic1f106684270a8f2197e0fb2a67d6fc00535ee65 we now require
msgfmt (a binary in the gettext package) to be installed for pep8
to pass. This hasn't failed in the gate because infra already
installs that package. We should make sure new devs know to do
that thing as well.
Change-Id: Iac505ddd54466e8a6272fee5ff61aac180c90ac4
Add the native distro packages for python 3 development to the dev
quickstart guide (needed for running the tox py34 target).
Change-Id: Iae651ac2f7d4b050cba46ee27e5a6d4232f3fddc
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
Commit bd7e62f796 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 bd7e62f796.
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
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
* Just point to dvstack docs
* Don't go into advanced tox features like '--notest' and how to source
a env that tox builds. These are beyond setting up your environment.
And are not very nova specific.
* Don't show how to build man pages, they are very out of date and
mostly useless anyway.
* Drop 12.04 based install instructions
* We don't need libvirt-dev to run unit tests anymore
Change-Id: I3fab352e2d9d7cb64ebfe2603ec658768fdd0e44
* 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
Pranav Salunke