[dev] Re: How to build the API docs?

[Torf <ma...@torf.cc>]

I've found the solution: The API docs are usually only created when
Sphinx is running on RTD using code in `docs/conf.py`. To create them
manually, just fake running on RTD:

	$ READTHEDOCS=True make html

Note that while this does build the API documentation it'll still look
different from RTD because RTD use a non-default Sphinx theme. However,
in contrast to running `python setup.py apidocs` the content is the same.


Regards,
Torf

On 10.08.2015 12:08, Torf wrote:
> Hi everybody,
> 
> I'm trying to build the API reference documentation from the docstrings.
> However, running `make html` in the `docs` directory only generates the
> normal documentation (from the .rst files) and while running `python
> setup.py apidocs` from the root directory does generate an API
> documentation it doesn't look like the one hosted on RTD [0] and doesn't
> seem to understand the docstring syntax constructs LibCloud is using.
> What am I missing?
> 
> 
> Regards,
> Torf
> 
> 
> [0] https://libcloud.readthedocs.org/en/latest/apidocs/modules.html
>