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

DOC: update documentation build instructions #102

Merged
merged 1 commit into from
Jul 26, 2024
Merged

DOC: update documentation build instructions #102

merged 1 commit into from
Jul 26, 2024

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Jul 25, 2024

As mentioned in #95 (review), we usually build the documentation with:

$ python -m sphinx docs/ build/html -b html

This pull request updates CONTRIBUTING.rst accordingly:

image

@hagenw hagenw mentioned this pull request Jul 25, 2024
Merged
ChristianGeng
ChristianGeng approved these changes Jul 26, 2024
View reviewed changes
Copy link
Member

@ChristianGeng ChristianGeng left a comment

Choose a reason for hiding this comment

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

  • Brings the doc build back to the conventional
  • adds instructions for how to enforce anonymous data repository access

This can be approved.

@hagenw hagenw merged commit 38b46ee into main Jul 26, 2024
7 checks passed
@hagenw hagenw deleted the update-docs-build-instructions branch July 26, 2024 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ChristianGeng ChristianGeng ChristianGeng approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hagenw @ChristianGeng