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

RST rendering on github #50

Closed
dkirkby opened this issue Oct 4, 2017 · 8 comments
Closed

RST rendering on github #50

dkirkby opened this issue Oct 4, 2017 · 8 comments
Assignees
Labels

Comments

@dkirkby
Copy link
Member

dkirkby commented Oct 4, 2017

Environment variables in the tutorial page render on github as:

:envvar:`DESISURVEY_OUTPUT`

This might be a limitation of the github RST engine, but I believe that github is the only place someone might read this page. Assigning to @weaverba137 since he did the md->rst conversion.

@weaverba137
Copy link
Member

weaverba137 commented Oct 4, 2017

The when tutorial page appears on Read the Docs, the Sphinx rst formatting will be appropriate.

Note that the tutorial is included in the index.rst file.

@sbailey
Copy link
Contributor

sbailey commented Oct 4, 2017

In practice it isn't yet on readthedocs and we tend to link to github a lot anyway, so writing our rst in a way that looks good on github is still useful.

Is there any significant difference to using :envvar:DESI_OUTPUT vs. just DESI_OUTPUT or it it mainly a matter of formatting purity?

@dkirkby
Copy link
Member Author

dkirkby commented Oct 4, 2017

I see desisurvey on readthedocs but not surveysim.

@dkirkby dkirkby reopened this Oct 4, 2017
@weaverba137
Copy link
Member

I was going to set it up soon.

@weaverba137
Copy link
Member

Can I ask for just a teensy bit of patience here? The file is written in a way that is appropriate to Sphinx + Read the Docs. That is a good thing!

@dkirkby
Copy link
Member Author

dkirkby commented Oct 4, 2017

Its not urgent, thanks.

@weaverba137
Copy link
Member

http://surveysim.readthedocs.io/en/latest/tutorial.html is now active, though it also needs some minor fixes similar to desisurvey.

@weaverba137
Copy link
Member

Addressed by #51.

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

No branches or pull requests

3 participants