Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: generate docs using rtd #336

Merged
merged 1 commit into from
Jul 3, 2023

Conversation

PaulFarault
Copy link
Contributor

@PaulFarault PaulFarault commented Jun 29, 2023

Sphinx can understand Google style docstrings.

Theme is now read the docs.

Content has been splited between sources and build.

Which issue(s) this PR fixes

Fixes #330

Additional comments

  • Sphinx can understand Google style docstrings.
  • Theme is now read the docs.
  • Content has been splited between sources and build.

Agreements

@PaulFarault PaulFarault linked an issue Jun 29, 2023 that may be closed by this pull request
@PaulFarault PaulFarault requested a review from mdrutel June 29, 2023 14:31
@PaulFarault PaulFarault force-pushed the 330-doc-fix-doc-generation-with-sphinx branch from b929f75 to 4dc5808 Compare June 29, 2023 14:58
Sphinx can understand Google style docstrings.

Theme is now read the docs.

Content has been splited between sources and build.
@PaulFarault PaulFarault force-pushed the 330-doc-fix-doc-generation-with-sphinx branch from 4dc5808 to 29ca60a Compare June 29, 2023 15:10
@rpignolet
Copy link
Collaborator

Why content has been splited between sources and build ?

@PaulFarault
Copy link
Contributor Author

@rpignolet build was there before, it's the output of the html build. sources gather the rst which were before mixed with the rest, it feels cleaner that way and it follows the RTD tutorial's project structure.

@mdrutel
Copy link
Contributor

mdrutel commented Jul 3, 2023

Hi,

sphinx==4.5.0
sphinx_rtd_theme==1.2.2

I have multiple warnings when I try to make latexpdf :

WARNING: l'entrée html_static_path '_static' n'existe pas
[...]
/home/mdrutel01/projets/git/tdp-ops/tdp/tdp-lib/docs/source/developer/core/index.rst:4: WARNING: toctree contains reference to nonexisting document 'developer/core/dag'
/home/mdrutel01/projets/git/tdp-ops/tdp/tdp-lib/tdp/core/collection.py:docstring of tdp.core.collection.Collection.dag_directory:1: WARNING: description dupliquée pour l'objet tdp.core.collection.Collection.dag_directory; l'autre instance se trouve dans tdp.core, utilisez :noindex: sur l'une d'elles
/home/mdrutel01/projets/git/tdp-ops/tdp/tdp-lib/tdp/core/collection.py:docstring of tdp.core.collection.Collection.dag_yamls:1: WARNING: description dupliquée pour l'objet tdp.core.collection.Collection.dag_yamls; l'autre instance se trouve dans tdp.core, utilisez :noindex: sur l'une d'elles
[...]
La compilation a réussi, 45 avertissements.

Do we need to fix these ?

@PaulFarault
Copy link
Contributor Author

Most of them were there before. They are related to the writing of the doc, imo we need to fix them while rewriting the doc in another PR!

@PaulFarault PaulFarault merged commit d5c8a79 into master Jul 3, 2023
2 checks passed
@PaulFarault PaulFarault deleted the 330-doc-fix-doc-generation-with-sphinx branch July 3, 2023 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[doc] Fix doc generation with Sphinx
4 participants