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

39 mkdocs #56

Merged
merged 12 commits into from
Nov 3, 2023
Merged

39 mkdocs #56

merged 12 commits into from
Nov 3, 2023

Conversation

iacopy
Copy link
Owner

@iacopy iacopy commented Nov 2, 2023

Changes

Implement #39

  • Drop sphinx
  • Add mkdocs
  • Add plugin mkdocstrings
  • Add some documentation
  • Update dependencies on pyproject.toml

Deploy documentation to GitHub Pages.

You can deploy it manually:

just doc-deploy

Configuration:

/settings/pages
Source: deploy from a branch
Branch: gh-pages /(root)

poetry remove sphinx --group docs
poetry remove sphinx-sizzle-theme --group docs
poetry remove myst_parser --group docs
Issue #39
@iacopy iacopy added documentation CI Continuous Integration labels Nov 2, 2023
@iacopy iacopy linked an issue Nov 2, 2023 that may be closed by this pull request
the CleanPython page does not seem to work with `just doc` (poetry run mkdocs build) -- investigate,
but does work with poetry run mkdocs serve
Issue #39
to generate documentation
poetry add mkdocstrings --group docs
poetry add mkdocstrings[python] --group docs
Issue #39
mkdocs: configure mkdocstrings
add app.md with sections to add documentation to
Issue #39
dince I have an issue with building documentation locally, to be solved.
Issue #39
Deploy to GitHub pages.

/settings/pages
Source: deploy from a branch
Branch: gh-pages /(root)

Issue #39
@iacopy iacopy force-pushed the 39-mkdocs branch 2 times, most recently from f381cda to ca8fe8b Compare November 3, 2023 14:58
@iacopy iacopy merged commit 00c0294 into main Nov 3, 2023
4 checks passed
@iacopy iacopy deleted the 39-mkdocs branch November 3, 2023 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

mkdocs
1 participant