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

Create documentation and and a readthedocs page #29

Open
ivalaginja opened this issue Jun 14, 2019 · 1 comment
Open

Create documentation and and a readthedocs page #29

ivalaginja opened this issue Jun 14, 2019 · 1 comment
Labels
infrastructure Work on repo infrastructure

Comments

@ivalaginja
Copy link
Collaborator

ivalaginja commented Jun 14, 2019

For starters, set up the most rudimentary documentation page with Sphynx and make sure it works.

This will require unifying the doctoring style throughout the code.

This might be achieved in unison with #55, where we make the repo a package.

@hrwakeford
Copy link
Member

I am going to attempt to follow the following process from @christinahedges to make a webpage with the documentation associated with ExoTiC-ISM
https://christinahedges.github.io/astronomy_workflow/notebooks/3.0-building/mkdocs.html

This will be done and tested on a fork before issuing a pull request into this repo

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

No branches or pull requests

2 participants