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

Documentation facelift #242

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Documentation facelift #242

wants to merge 10 commits into from

Conversation

wiseodd
Copy link
Collaborator

@wiseodd wiseodd commented Sep 13, 2024

Closes #226.

I decided to use mkdocs-material, which is the standard in Python (see Astral's docs etc.).

@aleximmer, I added a deploy workflow. Could you disable the current one for pdoc? (Seems like it's hidden in the repo settings page.)

To review:

uv sync --all-extras
uv run mkdocs serve

then open localhost:8000

@wiseodd wiseodd mentioned this pull request Sep 14, 2024
@wiseodd wiseodd self-assigned this Sep 15, 2024
@wiseodd wiseodd added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rewrite documentation site
1 participant