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.

Sign up for GitHub

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

Jump to bottom

Closes #630 - Added Examples to Main page of Docs #655

Merged
merged 4 commits into from
Jul 1, 2019
Merged

Closes #630 - Added Examples to Main page of Docs #655

merged 4 commits into from
Jul 1, 2019

Conversation

singha95
Copy link
Contributor

@singha95 singha95 commented Jul 1, 2019

Added some images from the examples section to the main page for issue #630

Thank you for contributing to PlasmaPy! Please check out our development guide at:

http://docs.plasmapy.org/en/master/development/index.html

Here are a few things to keep in mind when making a pull request (PR).

  • Tests and docstrings are required for new or changed functionality.
  • Please take care to write helpful commit messages: https://chris.beams.io/posts/git-commit/
  • As a PR nears completion, fellow developers will likely suggest changes
    to be made before the PR is merged.
  • Every pull request should include a changelog entry. Please see
    changelog/README.rst for instructions.
  • PlasmaPy follows the PEP 8 style guide: https://www.python.org/dev/peps/pep-0008
  • Please double check that a new PR will not duplicate an existing PR.
  • If this PR will solve an issue tracked by GitHub, please add a phrase like
    "Closes Create classes to represent ionization state distributions #404." to automatically close the issue once the pull request is
    merged. If your PR will not completely solve the issue, please still
    reference the issue.
  • If this is your first contribution, please add your name to the author
    list in docs/about/credits.rst.
  • Feel free to chat with other developers on our Matrix channel at:
    https://riot.im/app/#/room/#plasmapy:matrix.org

Added Examples to Main page of Docs
ae88c6f 
Added some images from the examples section to the main page for issue PlasmaPy#630
@codecov
Copy link

codecov bot commented Jul 1, 2019 •
edited
Loading

Codecov Report

Merging #655 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #655   +/-   ##
=======================================
  Coverage   96.51%   96.51%           
=======================================
  Files          54       54           
  Lines        4563     4563           
=======================================
  Hits         4404     4404           
  Misses        159      159

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0ebc28e...cbe9079. Read the comment docs.

Added details about PR
dc7586f 
Added myself to the credits and created a new changelog file
@singha95 singha95 marked this pull request as ready for review July 1, 2019 00:22
StanczakDominik
StanczakDominik approved these changes Jul 1, 2019
View reviewed changes
Copy link
Member

@StanczakDominik StanczakDominik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks neat! I'll just reorder things on that page a little - please do tell what you think of the result visually, and then we can merge this! Thanks for coming up with this one :)

docs/index.rst
.. raw:: html

</div>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooooh.

Well, I feel dumb now for overlooking the "just add HTML" strategy, I was trying to get this done via sphinx gallery directives... This is perfectly fine and solves the issue of choosing examples though.

StanczakDominik
StanczakDominik reviewed Jul 1, 2019
View reviewed changes
docs/index.rst Outdated
:hidden:

/auto_examples/plot_distribution

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed these since they made the examples appear in the table of contents menu at the left side ("Braginskii coefficients" etc here):

image

@StanczakDominik
Copy link
Member

All right, I did a few experiments with the layout but ended up coming back to the initial suggestion - it's probably the best.

Gonna merge this as soon as tests pass, thanks @singha95 ! :)

@StanczakDominik StanczakDominik merged commit 36da3bc into PlasmaPy:master Jul 1, 2019
@namurphy namurphy added the docs PlasmaPy Docs at http://docs.plasmapy.org label May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StanczakDominik StanczakDominik StanczakDominik approved these changes

Assignees
No one assigned
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@singha95 @StanczakDominik @namurphy