Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
gb119 committed Mar 30, 2024
1 parent ca0c2a9 commit f3c768c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Modifiers
* aps1.5 - Switch to 1.5 column wide format
* aps2.0 - Switch to 2 column wide format
* aip2 - Switch to 2 column wide format for AIP journals
* stoner-dark - Switch to a dark background a lighter plotting colours.
* hi-res - Switches to 600dpi plotting (but using eps, pdf or svg is generally a better option)
* presentation_sm - a style for making 1/2 width graphs.
* presentation_dark - tweak the weight of elements for dark presnetations.
Expand All @@ -94,7 +95,7 @@ The default colour cycle is based on the London Underground map colour scheme (w
The package adds these as named colours in matplotlib, along with 90,50,70 and 10% shade variants of some of them. See
the [documentation page on colours](https://stonerlab.github.io/stonerplots/colours.html) for a full list.

This package draws heavily on [scienceplots]()https://github.com/garrettj403/SciencePlots, so it seems only fair to cite the original work....
This package draws heavily on [scienceplots](https://github.com/garrettj403/SciencePlots), so it seems only fair to cite the original work....

@article{StonerPlots,
author = {John D. Garrett},
Expand Down
12 changes: 12 additions & 0 deletions docs/source/style-gallery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ Notebooks
The *notebook* style is designed for Jupyter Notebooks.

.. image:: ../../examples/figures/fig05a.png

Check failure on line 156 in docs/source/style-gallery.rst

View workflow job for this annotation

GitHub Actions / pages

Error in "image" directive:
:alt: Notebook mode
:algn: center

Posters
~~~~~~~
Expand All @@ -162,22 +164,30 @@ The *poster* style makes everything bigger for printing onto an A0 poster. Shoul
for final printing.

.. image:: ../../examples/figures/fig05b.png

Check failure on line 166 in docs/source/style-gallery.rst

View workflow job for this annotation

GitHub Actions / pages

Error in "image" directive:
:alt: Poster mode
:algn: center

Presentations
~~~~~~~~~~~~~

The *presentation* style switches to a larger style, designed for use as a single graph on a PowerPoint presentation.

.. image:: ../../examples/figures/fig05c.png

Check failure on line 175 in docs/source/style-gallery.rst

View workflow job for this annotation

GitHub Actions / pages

Error in "image" directive:
:alt: Full width presentation mode
:algn: center

There is a *presnetation_sm* style for when you want two plots on a slide.

.. image:: ../../examples/figures/fig05d.png

Check failure on line 181 in docs/source/style-gallery.rst

View workflow job for this annotation

GitHub Actions / pages

Error in "image" directive:
:alt: Half-width presentation mode
:algn: center

The *stoner_dark* style does make everything look a bit heavier and bolder, so the *presentation_dark* lightens
everything up.

.. image:: ../../examples/figures/fig05e.png

Check failure on line 188 in docs/source/style-gallery.rst

View workflow job for this annotation

GitHub Actions / pages

Error in "image" directive:
:alt: Dark presentation mode
:algn: center

High Resolution Mode
~~~~~~~~~~~~~~~~~~~~
Expand All @@ -187,6 +197,8 @@ is not feasible and a bitmapped image is needed, then a higher dpi is needed. Th
style.

.. image:: ../../examples/figures/fig05f.png

Check failure on line 199 in docs/source/style-gallery.rst

View workflow job for this annotation

GitHub Actions / pages

Error in "image" directive:
:alt: 600dpi image mode.
:algn: center


6. Miscellaneous Tweaks
Expand Down

0 comments on commit f3c768c

Please sign in to comment.