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

From pdoc to mkdocs (to sphinx) #354

Closed
17 tasks done
veenstrajelmer opened this issue Apr 26, 2023 · 0 comments · Fixed by #355, #356, #358 or #846
Closed
17 tasks done

From pdoc to mkdocs (to sphinx) #354

veenstrajelmer opened this issue Apr 26, 2023 · 0 comments · Fixed by #355, #356, #358 or #846

Comments

@veenstrajelmer
Copy link
Collaborator

veenstrajelmer commented Apr 26, 2023

TODO:

  • remove old docgeneration actions (incl PAT)
  • add installation+issues to howto
  • cleanup readme further and put here instead
  • Comment deprecated(?)+errors+linebuilder+modelbuilder in api_reference.md
  • remove admonition?
  • add link to https://deltares.github.io/xugrid/user_guide.html in tutorials introduction and also point to xarray 45 minutes docs
  • "also create unittests" to "also create function docstrings and unittests"
  • check mkdocs warnings
  • rename tutorials/tutorials to tutorials/introduction
  • expand mkdocs with more ipynb files
  • include download link for notebooks in docs #776
  • modelbuilder notebook is already integrated, but no heading is visible under tutorials
  • check TODO and commented lines in mkdocs.yml >> not relevant anymore with sphinx
  • exclude many funtions from API reference, add structure to toc and exclude parameters/returns from toc
  • move to sphinx, just like ddlpy, although including notebooks is an issue there >> it worked in hatyan with choco install pandoc
  • update workflow file
  • update pyproject.toml dependencies for sphinx
@veenstrajelmer veenstrajelmer linked a pull request Apr 26, 2023 that will close this issue
@veenstrajelmer veenstrajelmer linked a pull request Apr 27, 2023 that will close this issue
@veenstrajelmer veenstrajelmer linked a pull request Apr 27, 2023 that will close this issue
This was referenced Jul 11, 2023
@veenstrajelmer veenstrajelmer changed the title From pdoc to mkdocs From pdoc to mkdocs (to sphinx) May 14, 2024
@veenstrajelmer veenstrajelmer linked a pull request May 15, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant