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.

Sign up for GitHub

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

Jump to bottom

Migrate docs site to material for mkdocs #284

Open
4 of 9 tasks
thobson88 opened this issue Dec 23, 2024 · 0 comments
Open
4 of 9 tasks

Migrate docs site to material for mkdocs #284

thobson88 opened this issue Dec 23, 2024 · 0 comments
Assignees
@thobson88

Comments

@thobson88
Copy link
Collaborator

thobson88 commented Dec 23, 2024 •
edited
Loading

Partially done on branch mkdocs, and merged into 276-refactor to capture changes outside the docs/ directory (mostly updated docstrings). To be continued on another feature branch after #286.

TODO:

  • Set up MkDocs site and translate from Sphinx version
  • Fix CI
  • Docs homepage
  • Getting Started section
  • Reference section
  • API section
  • Experiments section
  • Class diagrams & explanation for geoparser modules
  • Instructions for running granular tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thobson88 thobson88

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@thobson88