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

Add read the docs #31

Merged
merged 8 commits into from
Nov 22, 2023
Merged

Add read the docs #31

merged 8 commits into from
Nov 22, 2023

Conversation

endast
Copy link
Collaborator

@endast endast commented Nov 22, 2023

This pr adds read the docs to the DeepRVAT repo. The individual readme files have been moved to the docs directory.

The docs will be hosted here: deeprvat.readthedocs.io

We are using sphinx to build the docs with the following plugins:

asphinx-autodoc2 automatically generates API documentation
myst_parser A Sphinx and Docutils extension to parse MyST, a rich and extensible flavour of Markdown for authoring technical and scientific documentation.
sphinx_copybutton adds a little “copy” button to the right of our code blocks

image

@endast endast requested a review from Marcel-Mueck November 22, 2023 12:47
@endast endast self-assigned this Nov 22, 2023
Copy link
Collaborator

@Marcel-Mueck Marcel-Mueck left a comment

Choose a reason for hiding this comment

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

seems legit

@endast endast merged commit ef7bb5c into main Nov 22, 2023
7 checks passed
@endast endast deleted the feature-add-read-the-docs branch November 30, 2023 09:32
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.

2 participants