Commit 596627a

committed

Fix highlighting of install docs.

Almost all code-blocks should be highlighted as shell, not python (most were already tagged so, but some were still mis-highlighted). The remaining python blocks are actually all doctests, and can thus use their own rst syntax.

1 parent b2e8b93 commit 596627aCopy full SHA for 596627a

File tree

2 files changed

+35

-42

lines changed

doc/install
- index.rst
- troubleshooting_faq.inc.rst

2 files changed

+35

-42

lines changed

`‎doc/install/index.rst`

Lines changed: 13 additions & 18 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`.. redirect-from:: /users/installing`
`2`	`2`	`.. redirect-from:: /users/installing/index`
`3`	`3`
	`4`	`+.. highlight:: sh`
	`5`	`+`
`4`	`6`	`************`
`5`	`7`	`Installation`
`6`	`8`	`************`
`@@ -11,9 +13,7 @@ Install an official release`
`11`	`13`
`12`	`14`	`Matplotlib releases are available as wheel packages for macOS, Windows and`
`13`	`15`	Linux on `PyPI <https://pypi.org/project/matplotlib/>`_. Install it using
`14`		-``pip``:
`15`		`-`
`16`		`-.. code-block:: sh`
	`16`	+``pip``::
`17`	`17`
`18`	`18`	`python -m pip install -U pip`
`19`	`19`	`python -m pip install -U matplotlib`
`@@ -44,15 +44,11 @@ Various third-parties provide Matplotlib for their environments.`
`44`	`44`	`Conda packages`
`45`	`45`	`--------------`
`46`	`46`
`47`		`-Matplotlib is available both via the anaconda main channel`
`48`		`-`
`49`		`-.. code-block:: sh`
	`47`	`+Matplotlib is available both via the anaconda main channel ::`
`50`	`48`
`51`	`49`	`conda install matplotlib`
`52`	`50`
`53`		`-as well as via the conda-forge community channel`
`54`		`-`
`55`		`-.. code-block:: sh`
	`51`	`+as well as via the conda-forge community channel ::`
`56`	`52`
`57`	`53`	`conda install -c conda-forge matplotlib`
`58`	`54`
`@@ -62,10 +58,8 @@ Python distributions`
`62`	`58`	`Matplotlib is part of major Python distributions:`
`63`	`59`
`64`	`60`	- `Anaconda <https://www.anaconda.com/>`_
`65`		`-`
`66`	`61`	- `ActiveState ActivePython
`67`	`62`	<https://www.activestate.com/products/python/downloads/>`_
`68`		`-`
`69`	`63`	- `WinPython <https://winpython.github.io/>`_
`70`	`64`
`71`	`65`	`Linux package manager`
`@@ -90,9 +84,7 @@ Matplotlib makes nightly development build wheels available on the`
`90`	`84`	`scientific-python-nightly-wheels Anaconda Cloud organization
`91`	`85`	<https://anaconda.org/scientific-python-nightly-wheels>`_.
`92`	`86`	These wheels can be installed with ``pip`` by specifying
`93`		`-scientific-python-nightly-wheels as the package index to query:`
`94`		`-`
`95`		`-.. code-block:: sh`
	`87`	`+scientific-python-nightly-wheels as the package index to query::`
`96`	`88`
`97`	`89`	`python -m pip install \`
`98`	`90`	`--upgrade \`
`@@ -143,8 +135,7 @@ Aspects of some behavioral defaults of the library can be configured via:`
`143`	`135`	`environment_variables_faq.rst`
`144`	`136`
`145`	`137`	`Default plotting appearance and behavior can be configured via the`
`146`		-:ref:`rcParams file <customizing-with-matplotlibrc-files>`
`147`		`-`
	`138`	+:ref:`rcParams file <customizing-with-matplotlibrc-files>`.
`148`	`139`
`149`	`140`	`Dependencies`
`150`	`141`	`============`
`@@ -266,13 +257,17 @@ at the Terminal.app command line::`
`266`	`257`
`267`	`258`	`python3 -c 'import matplotlib; print(matplotlib.__version__, matplotlib.__file__)'`
`268`	`259`
`269`		`-You should see something like ::`
	`260`	`+You should see something like`
	`261`	`+`
	`262`	`+.. code-block:: none`
`270`	`263`
`271`	`264`	`3.10.0 /Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/matplotlib/__init__.py`
`272`	`265`
`273`	`266`	where ``3.10.0`` is the Matplotlib version you just installed, and the path
`274`	`267`	`following depends on whether you are using Python.org Python, Homebrew or`
`275`		`-Macports. If you see another version, or you get an error like ::`
	`268`	`+Macports. If you see another version, or you get an error like`
	`269`	`+`
	`270`	`+.. code-block:: none`
`276`	`271`
`277`	`272`	`Traceback (most recent call last):`
`278`	`273`	`File "<string>", line 1, in <module>`

`‎doc/install/troubleshooting_faq.inc.rst`

Lines changed: 22 additions & 24 deletions

Original file line number	Diff line number	Diff line change
`@@ -11,25 +11,23 @@ Obtaining Matplotlib version`
`11`	`11`	`----------------------------`
`12`	`12`
`13`	`13`	`To find out your Matplotlib version number, import it and print the`
`14`		-``__version__`` attribute::
`15`		`-`
`16`		`- >>> import matplotlib`
`17`		`- >>> matplotlib.__version__`
`18`		`- '0.98.0'`
	`14`	+``__version__`` attribute:
`19`	`15`
	`16`	`+>>> import matplotlib`
	`17`	`+>>> matplotlib.__version__`
	`18`	`+'0.98.0'`
`20`	`19`
`21`	`20`	`.. _locating-matplotlib-install:`
`22`	`21`
`23`	`22`	:file:`matplotlib` install location
`24`	`23`	`-----------------------------------`
`25`	`24`
`26`	`25`	`You can find what directory Matplotlib is installed in by importing it`
`27`		-and printing the ``__file__`` attribute::
`28`		`-`
`29`		`- >>> import matplotlib`
`30`		`- >>> matplotlib.__file__`
`31`		`- '/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/__init__.pyc'`
	`26`	+and printing the ``__file__`` attribute:
`32`	`27`
	`28`	`+>>> import matplotlib`
	`29`	`+>>> matplotlib.__file__`
	`30`	`+'/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/__init__.pyc'`
`33`	`31`
`34`	`32`	`.. _locating-matplotlib-config-dir:`
`35`	`33`
@@ -39,32 +37,32 @@ and printing the ``__file__`` attribute::
`39`	`37`	`Each user has a Matplotlib configuration directory which may contain a`
`40`	`38`	:ref:`matplotlibrc <customizing-with-matplotlibrc-files>` file. To
`41`	`39`	locate your :file:`matplotlib/` configuration directory, use
`42`		-:func:`matplotlib.get_configdir`::
	`40`	+:func:`matplotlib.get_configdir`:
`43`	`41`
`44`		`->>> import matplotlib as mpl`
`45`		`->>> mpl.get_configdir()`
`46`		`-'/home/darren/.config/matplotlib'`
	`42`	`+>>> import matplotlib as mpl`
	`43`	`+>>> mpl.get_configdir()`
	`44`	`+'/home/darren/.config/matplotlib'`
`47`	`45`
`48`	`46`	`On Unix-like systems, this directory is generally located in your`
`49`	`47`	:envvar:`HOME` directory under the :file:`.config/` directory.
`50`	`48`
`51`	`49`	`In addition, users have a cache directory. On Unix-like systems, this is`
`52`	`50`	`separate from the configuration directory by default. To locate your`
`53`		-:file:`.cache/` directory, use :func:`matplotlib.get_cachedir`::
	`51`	+:file:`.cache/` directory, use :func:`matplotlib.get_cachedir`:
`54`	`52`
`55`		`->>> import matplotlib as mpl`
`56`		`->>> mpl.get_cachedir()`
`57`		`-'/home/darren/.cache/matplotlib'`
	`53`	`+>>> import matplotlib as mpl`
	`54`	`+>>> mpl.get_cachedir()`
	`55`	`+'/home/darren/.cache/matplotlib'`
`58`	`56`
`59`	`57`	`On Windows, both the config directory and the cache directory are`
`60`	`58`	the same and are in your :file:`Documents and Settings` or :file:`Users`
`61`		`-directory by default::`
	`59`	`+directory by default:`
`62`	`60`
`63`		`->>> import matplotlib as mpl`
`64`		`->>> mpl.get_configdir()`
`65`		`-'C:\\Documents and Settings\\jdhunter\\.matplotlib'`
`66`		`->>> mpl.get_cachedir()`
`67`		`-'C:\\Documents and Settings\\jdhunter\\.matplotlib'`
	`61`	`+>>> import matplotlib as mpl`
	`62`	`+>>> mpl.get_configdir()`
	`63`	`+'C:\\Documents and Settings\\jdhunter\\.matplotlib'`
	`64`	`+>>> mpl.get_cachedir()`
	`65`	`+'C:\\Documents and Settings\\jdhunter\\.matplotlib'`
`68`	`66`
`69`	`67`	`If you would like to use a different configuration directory, you can`
`70`	`68`	do so by specifying the location in your :envvar:`MPLCONFIGDIR`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 596627a

File tree

2 files changed

2 files changed

`‎doc/install/index.rst`

`‎doc/install/troubleshooting_faq.inc.rst`

0 commit comments