You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@libcloud.apache.org by Lee Verberne <ve...@google.com> on 2015/03/31 23:09:30 UTC

[dev] Generating documentation

I'd like to improve some of the documentation formatting, but I'm having
trouble figure out how to build the apidocs.

When I run 'python setup.py apidocs', it appears to be interpreting docs as
epytext instead of rst, and so the resulting html looks very different from
what's on libcloud.readthedocs.org.

Could someone point me in the right direction?

Thanks,

-lee

Re: [dev] Generating documentation

Posted by Tomaz Muraus <to...@apache.org>.
Hey,

Either should do the trick:

tox -edocs


or

cd docs
make html


In second case you need to make sure sphinx and other Python dependencies
are installed and available in PYTHONPATH.

I will also make sure this info gets added to the documentation (so meta
:)).

On Tue, Mar 31, 2015 at 11:09 PM, Lee Verberne <ve...@google.com> wrote:

> I'd like to improve some of the documentation formatting, but I'm having
> trouble figure out how to build the apidocs.
>
> When I run 'python setup.py apidocs', it appears to be interpreting docs as
> epytext instead of rst, and so the resulting html looks very different from
> what's on libcloud.readthedocs.org.
>
> Could someone point me in the right direction?
>
> Thanks,
>
> -lee
>