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

chore: Add automation to support server doc gen and fix python doc gen v0 #2084

Merged
merged 11 commits into from
Aug 8, 2024

Conversation

tssweeney
Copy link
Collaborator

@tssweeney tssweeney commented Aug 7, 2024

This PR looks huge, but that is just because there are a lot of generated files and the yarn.lock changed a lot. Changes:

  1. Big one: make generate_reference_docs now generates python and service API docs
  2. Yarn update on docusaurus related packages
  3. Remove width constraint on docs to allow for more natural sizing
  4. Added a little dropdown for the reference docs (see screenshot below)
  5. Fixed python doc gen which was broken
Screenshot 2024-08-07 at 20 35 56

The following is hidden:
Screenshot 2024-08-07 at 20 37 12

Note: currently the API docs are hidden until we make our pre-release checklist, but the system is now setup.

Copy link

socket-security bot commented Aug 7, 2024

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request

@circle-job-mirror
Copy link

circle-job-mirror bot commented Aug 7, 2024

@tssweeney tssweeney changed the title dnm: Server API Docs System Part 1 chore: Add automation to support server doc gen Aug 8, 2024
@tssweeney tssweeney changed the title chore: Add automation to support server doc gen chore: Add automation to support server doc gen and fix python doc gen v0 Aug 8, 2024
@tssweeney tssweeney marked this pull request as ready for review August 8, 2024 03:57
@tssweeney tssweeney requested a review from a team as a code owner August 8, 2024 03:57
@@ -22,8 +22,8 @@
--ifm-color-primary-lighter: #359962;
--ifm-color-primary-lightest: #3cad6e;
--ifm-code-font-size: 85%;
--ifm-container-width: 800px;
--ifm-container-width-xl: 800px;
/* --ifm-container-width: 800px;
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could we remove entirely or add a comment about why this is commented out

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

removed

@tssweeney tssweeney enabled auto-merge (squash) August 8, 2024 15:47
@tssweeney tssweeney merged commit 87c4c59 into master Aug 8, 2024
27 checks passed
@tssweeney tssweeney deleted the tim/server_api_docs branch August 8, 2024 16:07
@github-actions github-actions bot locked and limited conversation to collaborators Aug 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants