Sphinx API docs improvements

apache / libcloud

Apache Libcloud is a Python library which hides differences between different cloud provider APIs and allows you to manage different cloud resources through a unified and easy to use API.

https://libcloud.apache.org

Apache License 2.0

2.03k stars 929 forks source link

Sphinx API docs improvements #1937

Closed Kami closed 11 months ago

Kami commented 11 months ago

This pull request includes the following sphinx API docs improvements:

Move api docs generation from tox file to sphinix config. This seems to be the preferred method. It allows us to re-use the same tox target locally and on CI and it also simplifies RTD approach.
Update sphinx-apidocs options to generate separate file for each modules. This makes linking to docs for a specific module easier.
Update sphinx-apidocs options to exclude test modules from the api docs.

Those changes should also drastically speed up the docs build time on ReadTheDocs (down to ~200 seconds from ~700 seconds).

codecov-commenter commented 11 months ago

Codecov Report

Merging #1937 (d7f0a8b) into trunk (794818c) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##            trunk    #1937   +/-   ##
=======================================
  Coverage   83.18%   83.18%           
=======================================
  Files         352      352           
  Lines       81329    81329           
  Branches     8579     8579           
=======================================
  Hits        67652    67652           
  Misses      10873    10873           
  Partials     2804     2804