Skip to content

root: add generated Source docs#5323

Merged
BeryJu merged 1 commit intomainfrom
root/source-docs
Jul 31, 2023
Merged

root: add generated Source docs#5323
BeryJu merged 1 commit intomainfrom
root/source-docs

Conversation

@BeryJu
Copy link
Member

@BeryJu BeryJu commented Apr 20, 2023

Instead of maintaining duplicate docs of certain objects in docusaurus and in the code, generate source docs with pdoc and link to those

@BeryJu BeryJu force-pushed the root/source-docs branch from a56d70e to 9ef164e Compare April 20, 2023 11:40
@codecov
Copy link

codecov bot commented Apr 20, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.31% 🎉

Comparison is base (33e7903) 92.42% compared to head (9ef164e) 92.73%.

❗ Current head 9ef164e differs from pull request most recent head 2de09e7. Consider uploading reports for the commit 2de09e7 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5323      +/-   ##
==========================================
+ Coverage   92.42%   92.73%   +0.31%     
==========================================
  Files         561      506      -55     
  Lines       27053    25916    -1137     
==========================================
- Hits        25001    24030     -971     
+ Misses       2052     1886     -166     
Flag Coverage Δ
e2e 52.66% <ø> (+1.62%) ⬆️
integration 26.37% <ø> (-0.13%) ⬇️
unit 89.53% <ø> (+0.26%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
authentik/core/models.py 92.41% <ø> (-0.30%) ⬇️
authentik/events/models.py 93.24% <ø> (-0.18%) ⬇️

... and 206 files with indirect coverage changes

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

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
@BeryJu BeryJu force-pushed the root/source-docs branch from 9ef164e to 2de09e7 Compare July 31, 2023 09:58
@BeryJu BeryJu requested a review from a team as a code owner July 31, 2023 09:58
@BeryJu BeryJu requested review from kensternberg-authentik and removed request for a team July 31, 2023 09:58
@netlify
Copy link

netlify bot commented Jul 31, 2023

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 2de09e7
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/64c785ca5d1c5600086cf914

@BeryJu BeryJu merged commit 09907ec into main Jul 31, 2023
@BeryJu BeryJu deleted the root/source-docs branch July 31, 2023 09:59
kensternberg-authentik added a commit that referenced this pull request Aug 7, 2023
* main:
  blueprints: prevent duplicate password stage in default flow when using combined identification stage (#6432)
  website/integrations: cite better (#6431)
  root: add generated Source docs (#5323)
  website/docs: add architecture and persistence (#6250)
  core: bump paramiko from 3.2.0 to 3.3.1 (#6428)
  website: fix sidebar sizing (#6430)
  ci: update dependabot labels (#6423)
  website: fix sidebar layout (#6421)
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.

1 participant