Open Stack

On 07/30/2013 05:50 PM, Lorin Hochstein wrote:
> Roberto:
>
> I'm honestly not sure how that particular file was generated. I think
> that may even be leftover HTML that was never cleaned up from an older
> build.
>
> In general, to build the developer docs, you would install sphinx (e.g.,
> "pip install Sphinx")  and then from the root of the repository, do:
>
> cd doc
> make
>
> If you want to build latex sources, do:
>
> cd doc
> make latex
>

Hi Lorin

thanks for the answer. Unfortunately, it seems that the doc/source
directory does not contain the necessary content to generate the
code documentation (the html files generated are almost empty).
The command I executed to generate the documentation is:

tox -evenv -- python setup.py build_sphinx


I partially solved this issue by creating a new file in
doc/source/devref, with the following text:

----
Source: quantum/agent/rpc.py
============================

.. automodule:: quantum.agent.rpc
   :members:
   :undoc-members:
   :show-inheritance:
----

and including it in doc/source/index.rst. With these operations,
I generated the documentation of quantum/agent/rpc.py only.

Regards

Roberto Sassu


>
>
> Lorin
>
>
> On Tue, Jul 30, 2013 at 4:34 AM, Roberto Sassu <roberto.sassu at polito.it
> <mailto:roberto.sassu at polito.it>> wrote:
>
>     Hi everyone
>
>     I'm trying to generate the sphinx documentation
>     for Quantum code (version: Folsom). I would like
>     to generate the html page at the following URL:
>
>     http://docs.openstack.org/__developer/quantum/api/quantum.__plugins.openvswitch.ovs___quantum_plugin.html
>     <http://docs.openstack.org/developer/quantum/api/quantum.plugins.openvswitch.ovs_quantum_plugin.html>
>
>     How can I obtain this result? Can I also generate
>     latex sources of the whole documentation?
>
>     Thanks
>
>     Roberto Sassu
>
>
>     _________________________________________________
>     Openstack-docs mailing list
>     Openstack-docs at lists.__openstack.org
>     <mailto:Openstack-docs at lists.openstack.org>
>     http://lists.openstack.org/__cgi-bin/mailman/listinfo/__openstack-docs
>     <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>
>
>
>
>
> --
> Lorin Hochstein
> Lead Architect - Cloud Services
> Nimbis Services, Inc.
> www.nimbisservices.com <http://www.nimbisservices.com>