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

Update readthedocs to have an overview and tutorial sections #129

Open
rgerkin opened this issue Feb 5, 2020 · 5 comments
Open

Update readthedocs to have an overview and tutorial sections #129

rgerkin opened this issue Feb 5, 2020 · 5 comments
Assignees
Milestone

Comments

@rgerkin
Copy link
Contributor

rgerkin commented Feb 5, 2020

Currently it is just API docs, and the overview and tutorials are distributed through GitHub and the project site. They should also appear in the readthedocs site with the auto-generated API documentation. Several .rst files will need to be created.
@ChihweiLHBird

@rgerkin rgerkin self-assigned this Feb 5, 2020
@rgerkin rgerkin added this to the 0.3 milestone Feb 5, 2020
@ChihweiLHBird
Copy link
Contributor

Can they (.rst files) be automatically generated by sphinx? Or I should create them manually?

@rgerkin
Copy link
Contributor Author

rgerkin commented Feb 5, 2020

These will need to be created manually (or from a tool that converts markdown files (.md) or html to .rst). Some good starting point for the source material would be:

  • The README.md at the root of this repository
  • The html output of any of the notebooks in the /docs directory of this repository
  • The content of http://sciunit.io/sciunit.html
    If one or more of the above could be at the main page of the docs at http://sciunit.readthedocs.io that would be great. Right now it is just an index with auto-generated API documentation.

@ChihweiLHBird
Copy link
Contributor

These will need to be created manually (or from a tool that converts markdown files (.md) or html to .rst). Some good starting point for the source material would be:

  • The README.md at the root of this repository
  • The html output of any of the notebooks in the /docs directory of this repository
  • The content of http://sciunit.io/sciunit.html
    If one or more of the above could be at the main page of the docs at http://sciunit.readthedocs.io that would be great. Right now it is just an index with auto-generated API documentation.

Great, let me see how can I work on this.

@ChihweiLHBird
Copy link
Contributor

Readme was added to index.rst. A pull request for it was created.

@ChihweiLHBird
Copy link
Contributor

Fixed in 57c6742

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants