The current solution for documentation generation for GitHub pages (link here) has some flaws. These are:
New packages, classes, etc. are not included and the process to include them is unclear.
The build of documents is stored in the package, cluttering the docs directory.
The code documentation lacks some aspects (code examples, type hints).
The license is of 2018.
The style is outdated.
There is no landing page.
The current solution is based on sphinx (used in many projects). How do they organize it?
Following the example of sklearn, there is a mix of both generated and explicitly written documentation in the rst files.
Example of an explicit documentation page: Tree, rst.
Example of a generated documentation page: DecisionTreeClassifier, docstring (No idea how examples notebooks are put in the generated docs).
Sphinx is the basis of documents for many packages (torch is a giant one but super messy, sklearn in between, fairlearn is smaller and pretty clean).
Style is is normaly stored in _static/css or have a dedicated directory for the effect (the case of Sklearn).
Landing pages are a bit weird to see how they are done.
The current solution for documentation generation for GitHub pages (link here) has some flaws. These are:
docs
directory.The current solution is based on sphinx (used in many projects). How do they organize it? Following the example of
sklearn
, there is a mix of both generated and explicitly written documentation in therst
files.rst
.docstring
(No idea how examples notebooks are put in the generated docs).Sphinx is the basis of documents for many packages (
torch
is a giant one but super messy,sklearn
in between,fairlearn
is smaller and pretty clean).Style is is normaly stored in
_static/css
or have a dedicated directory for the effect (the case ofSklearn
).Landing pages are a bit weird to see how they are done.