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

Add Mkdocs support #6191

Merged
merged 4 commits into from
Jan 11, 2024
Merged

Add Mkdocs support #6191

merged 4 commits into from
Jan 11, 2024

Conversation

robsavoye
Copy link
Collaborator

This adds initial support for using Mkdocs to publish documentation. When #6190 is merged, then the internal API documentation also gets published. Currently this is only a reworking of the existing documentation to support publication. I figure better to have a small PR, the doc updates will be future PRs.

For an example of how this looks, see the version in my TM fork:
https://robsavoye.github.io/tasking-manager/

@robsavoye robsavoye added the scope: documentation Any issue that relates to documentation edits, updates, improvements label Jan 8, 2024
@robsavoye robsavoye self-assigned this Jan 8, 2024
Copy link

sonarcloud bot commented Jan 8, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@robsavoye
Copy link
Collaborator Author

This will allow TM to publish all the documentation for TM to GH Pages.

@robsavoye robsavoye merged commit 56b55cc into hotosm:develop Jan 11, 2024
6 checks passed
@robsavoye robsavoye deleted the mkdocs branch January 16, 2024 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: documentation Any issue that relates to documentation edits, updates, improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants