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

[Documentation] Make documentation reachable via web #7

Closed
hearot opened this issue Jun 12, 2020 · 1 comment
Closed

[Documentation] Make documentation reachable via web #7

hearot opened this issue Jun 12, 2020 · 1 comment
Assignees
Labels
approved A feature which has been approved and will be added to Pyrubrum. documentation Improvements or additions to documentation
Milestone

Comments

@hearot
Copy link
Owner

hearot commented Jun 12, 2020

Describe the issue
The built-in PyDoc is a great tool to explore documentation when you don't have an Internet connection, but it is poor, minimal. Tools like Sphinx, instead, give the user more readability and confidence.

Expected behavior
Make the documentation public using Sphinx and services such as Read the Docs.

Additional context
This issue contains an idea that was provided by #1 in the first place.

@hearot hearot added documentation Improvements or additions to documentation approved A feature which has been approved and will be added to Pyrubrum. labels Jun 12, 2020
@hearot hearot added this to the v0.1 milestone Jun 12, 2020
@hearot hearot self-assigned this Jun 12, 2020
@hearot
Copy link
Owner Author

hearot commented Jun 12, 2020

In order to make the documentation compliant with Sphinx specifications, fixes have to be applied (e.g. do follow Sphinx instructions to refer to methods).

@hearot hearot closed this as completed in 54bf64e Jun 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved A feature which has been approved and will be added to Pyrubrum. documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant