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.

Sign up for GitHub

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

Jump to bottom

Set up documentation website #9

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Set up documentation website #9

wants to merge 12 commits into from
+2,649 −1,545

Conversation

pavithraes
Copy link
Member

@pavithraes pavithraes commented Nov 20, 2024 •
edited
Loading

Closes #3
Addresses Quansight-Labs/czi-bokeh-mgmt#14

This PR:

  • Sets up a Sphinx-website with PyData-Sphinx-Theme
  • Sets up ReadTheDocs config for deployment
  • Adds & runs some pre-commit hooks for formatting and spellchecks
    • Updates gitignore to include node_modules
  • Re-structures the audit findings to fit the docs layout better:
    • Move to /source
    • Update heading levels, and add new H1s based on file name
    • Update image and video embed formats
  • Add docs build and authoring instructions in contributing.md

We can set up the RTD deployment after merging.

@pavithraes pavithraes added area: documentation 📖 Improvements or additions to documentation type: task ✅ labels Nov 20, 2024
@pavithraes pavithraes marked this pull request as ready for review November 20, 2024 18:49
pavithraes
pavithraes commented Nov 20, 2024
View reviewed changes
a11y-audit/plot-tools/contrast-interactive-elements.md
Copy link
Member Author

Choose a reason for hiding this comment

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

I don't know why this shows as deleted. No files have been deleted, only moved to the source/ directory

Copy link
Collaborator

Choose a reason for hiding this comment

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

If you moved and then significantly changed the file, then git will recognize this as a removal and addition.

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

@mattpap mattpap mattpap left review comments

@trallard trallard Awaiting requested review from trallard

Assignees
No one assigned
Labels
area: documentation 📖 Improvements or additions to documentation needs: review 👀 type: task ✅
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

to-do: embed evidence videos in a smart way
2 participants
@pavithraes @mattpap