Skip to content

docs: migrate authd docs to Sphinx and RTD#646

Merged
edibotopic merged 11 commits intomainfrom
authd-docs-on-rtd
Nov 20, 2024
Merged

docs: migrate authd docs to Sphinx and RTD#646
edibotopic merged 11 commits intomainfrom
authd-docs-on-rtd

Conversation

@edibotopic
Copy link
Contributor

@edibotopic edibotopic commented Nov 19, 2024

This migrates Authd documentation from the wiki to Sphinx, in preparation for hosting on Read the Docs.
The migration will help the Authd team maintain and iterate the documentation from this starting point.

Notes:

  • Minor changes were made to CONTRIBUTING.md, including fixing links and typos
  • The CONTRIBUTING.md is transcluded into a howto/contributing that will be shown on the docs site
  • A broken link to LICENSE was removed from CONTRIBUTING.md
  • Images that were previously GitHub attachments for the wiki have been included as assets

UDENG-5314

- fixes broken links
- fixes spelling
- adds include markers for docs
- migrates content from wiki
- includes boilerplate for RTD hosting
- adds automated doc checks
@codecov-commenter
Copy link

codecov-commenter commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.28%. Comparing base (a469b87) to head (cd75aa5).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #646   +/-   ##
=======================================
  Coverage   83.28%   83.28%           
=======================================
  Files          80       80           
  Lines        8617     8617           
  Branches       75       75           
=======================================
  Hits         7177     7177           
  Misses       1112     1112           
  Partials      328      328           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@edibotopic edibotopic marked this pull request as ready for review November 19, 2024 17:15
@edibotopic edibotopic requested a review from a team as a code owner November 19, 2024 17:15
@edibotopic edibotopic changed the title docs: migrate Authd docs to Sphinx and RTD docs: migrate authd docs to Sphinx and RTD Nov 19, 2024
Copy link
Contributor

@adombeck adombeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I built the doc with make -C docs serve and it looks great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants