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

Next step: Read the Docs #3

Open
github-actions bot opened this issue Jul 5, 2023 · 0 comments
Open

Next step: Read the Docs #3

github-actions bot opened this issue Jul 5, 2023 · 0 comments

Comments

@github-actions
Copy link

github-actions bot commented Jul 5, 2023

Your Python package should have publicly available documentation, including API documentation for your users.
Read the Docs can host your user documentation for you.

To host the documentation of this repository please perform the following instructions:

  1. go to Read the Docs
  2. log in with your GitHub account
  3. find dianna-ai/distance_explainer in list and press + button.
    • If repository is not listed,
      1. go to Read the Docs GitHub app
      2. make sure dianna-ai has been granted access.
      3. reload repository list on Read the Docs import page
  4. wait for the first build to be completed at https://readthedocs.org/projects/distance_explainer/builds
  5. check that the link of the documentation badge in the README.md works

See README.dev.md# how to build documentation site locally.

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

No branches or pull requests

0 participants