Update GitHub pages #154
Labels
Base
Regards the base package
enhancement
New feature or request
javascript
Pull requests that update Javascript code
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.
The text was updated successfully, but these errors were encountered: