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

Code not showing up in maps.rst for plotting keywords and colormap section #2046

Closed
prateekiiest opened this issue Mar 17, 2017 · 3 comments
Closed

Comments

@prateekiiest
Copy link
Contributor

Some codework is not being showed up in the maps.rst section - https://github.com/sunpy/sunpy/blob/master/doc/source/guide/data_types/maps.rst#plotting-keywords

which is present in the current documents http://docs.sunpy.org/en/latest/guide/data_types/maps.html#plotting-keywords.

Also I think it would be better if we could upload the generated plots and the images in the .rst files.

@Cadair
Copy link
Member

Cadair commented Mar 17, 2017

Look at the raw rst file: https://raw.githubusercontent.com/sunpy/sunpy/master/doc/source/guide/data_types/maps.rst the code is there.

Because it's a plot directive block to automatically generate the code and the plot it does not show up on GitHub's rubbish rst renderer.

@Cadair Cadair closed this as completed Mar 17, 2017
@prateekiiest
Copy link
Contributor Author

But shouldn't we show the code snippet as a preview under the doc/source file.
I saw the code is there, but its not showing up in the preview.

@Cadair
Copy link
Member

Cadair commented Mar 17, 2017

that's a limitation of github, not something we have control over. We put a lot of effort into the docs so that they keep up to date with code changes as automatically as possible, which is why we generate these scripts at build time.

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

2 participants