Skip to content
This repository has been archived by the owner on Dec 8, 2024. It is now read-only.

Sphinx improvements #21

Merged
merged 5 commits into from
Aug 18, 2024
Merged

Sphinx improvements #21

merged 5 commits into from
Aug 18, 2024

Conversation

LimaoC
Copy link
Owner

@LimaoC LimaoC commented Aug 17, 2024

In lieu of the restrictions around using GitHub pages for hosting our documentation...

  • Adds a Sphinx theme (see below for screenshot)
  • Adds some Makefile commands for building documentation, notably make docs-live to spin up a local server to host the documentation and hot-reload whenever code changes are made (this took me so damn long I'm going crazy)
  • Makes sure all the current code conforms to the Google-style docstring to make sphinx-napoleon happy.

Documentation example screenshot:
image

@LimaoC LimaoC requested a review from MitchellJC August 17, 2024 13:14
@LimaoC LimaoC self-assigned this Aug 17, 2024
Copy link
Collaborator

@MitchellJC MitchellJC left a comment

Choose a reason for hiding this comment

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

lgtm

client/models/pose_detection/landmarking.py Outdated Show resolved Hide resolved
client/models/pose_detection/landmarking.py Show resolved Hide resolved
client/models/pose_detection/landmarking.py Show resolved Hide resolved
@LimaoC LimaoC requested a review from MitchellJC August 18, 2024 01:30
Copy link
Collaborator

@MitchellJC MitchellJC left a comment

Choose a reason for hiding this comment

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

lgtm

@LimaoC LimaoC merged commit 7390bb5 into main Aug 18, 2024
2 checks passed
@LimaoC LimaoC deleted the sphinx-improvements branch August 18, 2024 01:38
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