Skip to content

Commit 62dba12

Browse files
committed
Update docs
1 parent 55d5e4d commit 62dba12

File tree

4 files changed

+20
-26
lines changed

4 files changed

+20
-26
lines changed

docs/sources/cli.rst

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,5 @@ is displayed.
5353

5454
.. option:: --create
5555

56-
Create a new config file from scratch. This is useful if your configuration
57-
file is broken or you want to reset the modifications you made to your
58-
configuration.
59-
60-
.. option:: --update
61-
62-
Add missing entries to your config file (or create a new one if necessary).
63-
64-
.. option:: --edit
65-
66-
Open your config file in ``vim``.
56+
Create a new config file from scratch.
6757

docs/sources/install.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,22 @@ for more information about installing Python packages.
3232
Some setup
3333
----------
3434

35-
Run the following once to create your config file (in ``~/.config/stagpy/``)::
35+
Run the following to create a local config file (``.stagpy.toml``)::
3636

3737
% stagpy config --create
3838

3939
You can enable command-line auto-completion if you use either bash or zsh.
4040

41-
Add this to your ``~/.bashrc`` file::
41+
For bash::
4242

43-
source ~/.config/stagpy/bash/stagpy.sh
43+
# adapt path as appropriate for your system
44+
% mkdir -p ~/.local/share/bash-completion/completions
45+
% cd !$
46+
% stagpy completions --bash
4447

45-
Or this to your ``~/.zshrc`` file::
48+
For zsh, with ``fpath+=~/.zfunc`` in your ``.zshrc``::
4649

47-
source ~/.config/stagpy/zsh/_stagpy.sh
50+
% cd ~/.zfunc
51+
% stagpy completions --zsh
4852

4953
Enjoy!

docs/sources/stagyydata.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Parameters set in the ``par`` file are accessible through the
8181
a dictionary of dictionaries. For example, to access the Rayleigh number from
8282
the ``refstate`` section of the par file, one can use
8383
``sdat.par['refstate']['ra0']``. Parameters that are not set in the par file
84-
are given a default value according to the par file ``~/.config/stagpy/par``.
84+
are given a default value.
8585

8686
Radial profiles
8787
---------------

docs/sources/tuto.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,13 @@ use the :class:`~stagpy.stagyydata.StagyyData` class.
112112
Plotting style
113113
--------------
114114

115-
StagPy defines two custom plotting styles for matplotlib, ``stagpy-paper`` (the
116-
default) and ``stagpy-slides``. You can edit them to your convenience, they
117-
are in the ``~/.config/stagpy`` directory. You can specify which style to use
118-
with ``plot.mplstyle``, available in the command line interface with the
119-
``--mplstyle`` option. You can specify a space-separated list to combine
120-
several styles. For example, if you want a dark-background figure with a
121-
font size adapted for slides, you can use the following command::
122-
123-
% stagpy field --mplstyle='dark_background stagpy-slides'
115+
For convenience, StagPy defines two custom plotting styles for matplotlib,
116+
``stagpy-paper`` (the default when using the CLI) and ``stagpy-slides``. You
117+
can specify which style to use with ``plot.mplstyle``, available in the command
118+
line interface with the ``--mplstyle`` option. You can specify a
119+
comma-separated list to combine several styles. For example, if you want a
120+
dark-background figure with a font size adapted for slides, you can use the
121+
following command::
122+
123+
% stagpy field --mplstyle='dark_background,stagpy-slides'
124124

0 commit comments

Comments
 (0)