Add documentation structure #13
Conversation
|
@PicoCentauri
Edit: I've added both. The documentation preview is not tested yet, as it doesn't work for the PR that introduces it. Here is the documentation for this PR: |
docs/src/conf.py
Outdated
| project = 'metatensor-models' | ||
| copyright = '2023, metatensor-models developers' | ||
| author = 'metatensor-models developers' | ||
| release = '2023.11.29' |
There was a problem hiding this comment.
I would parse everything from the pyproject.toml to not have this twice. You can take a look at skmatter for some inspiration.
There was a problem hiding this comment.
In general some intersphinx and all the options we use in metatensor for organizing the docstring are very useful and should be added.
| :maxdepth: 1 | ||
|
|
||
| quickstart | ||
| how-to |
There was a problem hiding this comment.
I think we should also add our utils functions maybe as a subfolder API in the docs. Even if they are not essentials for the enduser they are useful if you want to develop something.
There was a problem hiding this comment.
Utils are mainly for developers, which are not really the target of our documentation. I would add them under how-to/"add a new model" perhaps?
There was a problem hiding this comment.
we can also have two separate doc sections: one for users and one for devs. Rascaline does something like this.
|
The version is now being parsed. All the rest is still |
PicoCentauri
force-pushed
the
docs
branch
2 times, most recently
from
e1b2b9b to
c548c50
Compare
docs/src/conf.py
Outdated
| "footer_icons": [ | ||
| { | ||
| "name": "GitHub", | ||
| "url": "https://github.com/ceriottm/MeshLODE", |
There was a problem hiding this comment.
Sorry I forgot to add the toml parsing here.
docs/src/conf.py
Outdated
|
|
||
| # Add any Sphinx extension module names here, as strings. They can be | ||
| # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
| # ones. | ||
| extensions = [ | ||
| 'sphinx_rtd_dark_mode', |
There was a problem hiding this comment.
How did you manage to keep the dark mode even though you deleted this?
EDIT: I see that the build failed so I'm probably seeing an old version
There was a problem hiding this comment.
I would keep the dark mode as the default. In terms of marketing, this is a very simple change that would allow us to stand out from all the packages which use the default themes at near-zero additional effort. I've also noticed that a lot of display issues (things that look weird in light mode) disappear in dark mode
There was a problem hiding this comment.
Darkmode is still the default. Note that we are not using the RTD docs theme anymore but furo (which we also use the other lab-cosmo packages).
No description provided.