| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 0ac170b commit fa56972
13 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -121,8 +121,7 @@ def _parse_skip_subdirs_file(): | |||
| 121 | 121 | ] | |
| 122 | 122 | ||
| 123 | 123 | exclude_patterns = [ | |
| 124 | - 'api/prev_api_changes/api_changes_*/*' | ||
| 125 | - ] | ||
| 124 | + 'api/prev_api_changes/api_changes_*/*', '*.inc.*'] | ||
| 126 | 125 | ||
| 127 | 126 | exclude_patterns += skip_subdirs | |
| 128 | 127 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -240,17 +240,26 @@ Setup dependencies | |||
| 240 | 240 | C++ compiler | |
| 241 | 241 | ------------ | |
| 242 | 242 | ||
| 243 | - Matplotlib requires a C++ compiler that supports C++11. | ||
| 243 | + Matplotlib requires a C++ compiler that supports C++11. Typically, on Linux, you | ||
| 244 | + will need ``gcc``, which should be installed using your distribution's package | ||
| 245 | + manager; on macOS, you will need xcode; on Windows, you will need | ||
| 246 | + Visual Studio 2015 or later. Specifically: | ||
| 244 | 247 | ||
| 245 | - - `gcc 4.8.1 <https://gcc.gnu.org/projects/cxx-status.html#cxx11>`_ or higher. For gcc <6.5 you will | ||
| 246 | - need to set ``$CFLAGS=-std=c++11`` to enable C++11 support. | ||
| 248 | + - `gcc 4.8.1 <https://gcc.gnu.org/projects/cxx-status.html#cxx11>`_ or higher. For gcc <6.5 you will need to set ``$CFLAGS=-std=c++11`` to enable C++11 support. | ||
| 247 | 249 | `Installing GCC: Binaries <https://gcc.gnu.org/install/binaries.html>`_. | |
| 248 | 250 | - `clang 3.3 <https://clang.llvm.org/cxx_status.html>`_ or higher. | |
| 249 | 251 | `LLVM Download Page <https://releases.llvm.org/download.html>`_. | |
| 250 | 252 | - `Visual Studio 2015 | |
| 251 | 253 | <https://docs.microsoft.com/en-us/cpp/overview/visual-cpp-language-conformance?view=msvc-140>`_ | |
| 252 | 254 | (aka VS 14.0) or higher. A free version of Build Tools for Visual Studio is available for | |
| 253 | 255 | `download <https://visualstudio.microsoft.com/downloads/?q=build+tools>`_. | |
| 256 | + - `xcode <https://developer.apple.com/xcode/>`_ for Apple platform development | ||
| 257 | + | ||
| 258 | + For those using Visual Studio, make sure "Desktop development with C++" is | ||
| 259 | + selected, and that the latest MSVC, "C++ CMake tools for Windows," and a | ||
| 260 | + Windows SDK compatible with your version of Windows are selected and installed. | ||
| 261 | + They should be selected by default under the "Optional" subheading, but are | ||
| 262 | + required to build Matplotlib from source. | ||
| 254 | 263 | ||
| 255 | 264 | ||
| 256 | 265 | .. _test-dependencies: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -21,6 +21,12 @@ To set up Matplotlib for development follow these steps: | |||
| 21 | 21 | .. contents:: | |
| 22 | 22 | :local: | |
| 23 | 23 | ||
| 24 | + Install Dependencies | ||
| 25 | + ==================== | ||
| 26 | + Most Python dependencies will be installed when :ref:`setting up the environment <dev-environment>` | ||
| 27 | + but non-Python dependencies like C++ compilers, LaTeX, and other system applications | ||
| 28 | + must be installed separately. For a full list, see :ref:`dependencies`. | ||
| 29 | + | ||
| 24 | 30 | Fork the Matplotlib repository | |
| 25 | 31 | ============================== | |
| 26 | 32 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -78,6 +78,7 @@ Development environment | |||
| 78 | 78 | .. grid:: 1 1 2 2 | |
| 79 | 79 | ||
| 80 | 80 | .. grid-item-card:: | |
| 81 | + :shadow: none | ||
| 81 | 82 | ||
| 82 | 83 | **Install** | |
| 83 | 84 | ^^^ | |
@@ -91,9 +92,11 @@ Development environment | |||
| 91 | 92 | :maxdepth: 1 | |
| 92 | 93 | ||
| 93 | 94 | dependencies | |
| 95 | + ../users/installing/environment_variables_faq.inc.rst | ||
| 94 | 96 | ||
| 95 | 97 | ||
| 96 | 98 | .. grid-item-card:: | |
| 99 | + :shadow: none | ||
| 97 | 100 | ||
| 98 | 101 | **Workflow** | |
| 99 | 102 | ^^^^ | |
@@ -103,6 +106,10 @@ Development environment | |||
| 103 | 106 | ||
| 104 | 107 | development_workflow | |
| 105 | 108 | ||
| 109 | + .. toctree:: | ||
| 110 | + :maxdepth: 1 | ||
| 111 | + | ||
| 112 | + troubleshooting.rst | ||
| 106 | 113 | ||
| 107 | 114 | ||
| 108 | 115 | .. _contribution_guideline: | |
@@ -115,6 +122,7 @@ Policies and guidelines | |||
| 115 | 122 | :gutter: 2 | |
| 116 | 123 | ||
| 117 | 124 | .. grid-item-card:: | |
| 125 | + :shadow: none | ||
| 118 | 126 | ||
| 119 | 127 | **Code** | |
| 120 | 128 | ^^^ | |
@@ -128,6 +136,7 @@ Policies and guidelines | |||
| 128 | 136 | testing | |
| 129 | 137 | ||
| 130 | 138 | .. grid-item-card:: | |
| 139 | + :shadow: none | ||
| 131 | 140 | ||
| 132 | 141 | **Documentation** | |
| 133 | 142 | ^^^ | |
@@ -139,6 +148,7 @@ Policies and guidelines | |||
| 139 | 148 | style_guide | |
| 140 | 149 | ||
| 141 | 150 | .. grid-item-card:: | |
| 151 | + :shadow: none | ||
| 142 | 152 | ||
| 143 | 153 | **Triage** | |
| 144 | 154 | ^^^ | |
@@ -148,6 +158,7 @@ Policies and guidelines | |||
| 148 | 158 | | :ref:`triage_workflow` | |
| 149 | 159 | ||
| 150 | 160 | .. grid-item-card:: | |
| 161 | + :shadow: none | ||
| 151 | 162 | ||
| 152 | 163 | **Maintenance** | |
| 153 | 164 | ^^^ | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -56,7 +56,7 @@ Learn | |||
| 56 | 56 | users/explain/quick_start | |
| 57 | 57 | User guide <users/index.rst> | |
| 58 | 58 | tutorials/index.rst | |
| 59 | - users/faq/index.rst | ||
| 59 | + users/faq.rst | ||
| 60 | 60 | ||
| 61 | 61 | .. grid-item-card:: | |
| 62 | 62 | :padding: 2 | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,14 +1,12 @@ | |||
| 1 | 1 | .. _howto-faq: | |
| 2 | 2 | ||
| 3 | 3 | .. redirect-from:: /faq/howto_faq | |
| 4 | + .. redirect-from:: /users/faq/howto_faq | ||
| 5 | + .. redirect-from:: /faq/index | ||
| 4 | 6 | ||
| 5 | - ****** | ||
| 6 | - How-to | ||
| 7 | - ****** | ||
| 8 | - | ||
| 9 | - .. contents:: | ||
| 10 | - :backlinks: none | ||
| 11 | - | ||
| 7 | + ========================== | ||
| 8 | + Frequently Asked Questions | ||
| 9 | + ========================== | ||
| 12 | 10 | ||
| 13 | 11 | .. _how-to-too-many-ticks: | |
| 14 | 12 | ||
@@ -199,14 +197,8 @@ different scales, you can often get ylabels that do not align | |||
| 199 | 197 | vertically across the multiple subplots, which can be unattractive. | |
| 200 | 198 | By default, Matplotlib positions the x location of the ylabel so that | |
| 201 | 199 | it does not overlap any of the y ticks. You can override this default | |
| 202 | - behavior by specifying the coordinates of the label. The example | ||
| 203 | - below shows the default behavior in the left subplots, and the manual | ||
| 204 | - setting in the right subplots. | ||
| 205 | - | ||
| 206 | - .. figure:: ../../gallery/text_labels_and_annotations/images/sphx_glr_align_ylabels_001.png | ||
| 207 | - :target: ../../gallery/text_labels_and_annotations/align_ylabels.html | ||
| 208 | - :align: center | ||
| 209 | - :scale: 50 | ||
| 200 | + behavior by specifying the coordinates of the label. To learn how, see | ||
| 201 | + :doc:`/gallery/text_labels_and_annotations/align_ylabels` | ||
| 210 | 202 | ||
| 211 | 203 | .. _howto-set-zorder: | |
| 212 | 204 | ||
@@ -307,3 +299,79 @@ artists. | |||
| 307 | 299 | You may be able to work on separate figures from separate threads. However, | |
| 308 | 300 | you must in that case use a *non-interactive backend* (typically Agg), because | |
| 309 | 301 | most GUI backends *require* being run from the main thread as well. | |
| 302 | + | ||
| 303 | + .. _reporting-problems: | ||
| 304 | + | ||
| 305 | + Get help | ||
| 306 | + -------- | ||
| 307 | + | ||
| 308 | + There are a number of good resources for getting help with Matplotlib. | ||
| 309 | + There is a good chance your question has already been asked: | ||
| 310 | + | ||
| 311 | + - The `mailing list archive | ||
| 312 | + <https://discourse.matplotlib.org/c/community/matplotlib-users/6>`_. | ||
| 313 | + | ||
| 314 | + - `GitHub issues <https://github.com/matplotlib/matplotlib/issues>`_. | ||
| 315 | + | ||
| 316 | + - Stackoverflow questions tagged `matplotlib | ||
| 317 | + <https://stackoverflow.com/questions/tagged/matplotlib>`_. | ||
| 318 | + | ||
| 319 | + If you are unable to find an answer to your question through search, please | ||
| 320 | + provide the following information in your e-mail to the `mailing list | ||
| 321 | + <https://mail.python.org/mailman/listinfo/matplotlib-users>`_: | ||
| 322 | + | ||
| 323 | + * Your operating system (Linux/Unix users: post the output of ``uname -a``). | ||
| 324 | + | ||
| 325 | + * Matplotlib version:: | ||
| 326 | + | ||
| 327 | + python -c "import matplotlib; print(matplotlib.__version__)" | ||
| 328 | + | ||
| 329 | + * Where you obtained Matplotlib (e.g., your Linux distribution's packages, | ||
| 330 | + GitHub, PyPI, or `Anaconda <https://www.anaconda.com/>`_). | ||
| 331 | + | ||
| 332 | + * Any customizations to your ``matplotlibrc`` file (see | ||
| 333 | + :ref:`customizing`). | ||
| 334 | + | ||
| 335 | + * If the problem is reproducible, please try to provide a *minimal*, standalone | ||
| 336 | + Python script that demonstrates the problem. This is *the* critical step. | ||
| 337 | + If you can't post a piece of code that we can run and reproduce your error, | ||
| 338 | + the chances of getting help are significantly diminished. Very often, the | ||
| 339 | + mere act of trying to minimize your code to the smallest bit that produces | ||
| 340 | + the error will help you find a bug in *your* code that is causing the | ||
| 341 | + problem. | ||
| 342 | + | ||
| 343 | + * Matplotlib provides debugging information through the `logging` library, and | ||
| 344 | + a helper function to set the logging level: one can call :: | ||
| 345 | + | ||
| 346 | + plt.set_loglevel("info") # or "debug" for more info | ||
| 347 | + | ||
| 348 | + to obtain this debugging information. | ||
| 349 | + | ||
| 350 | + Standard functions from the `logging` module are also applicable; e.g. one | ||
| 351 | + could call ``logging.basicConfig(level="DEBUG")`` even before importing | ||
| 352 | + Matplotlib (this is in particular necessary to get the logging info emitted | ||
| 353 | + during Matplotlib's import), or attach a custom handler to the "matplotlib" | ||
| 354 | + logger. This may be useful if you use a custom logging configuration. | ||
| 355 | + | ||
| 356 | + If you compiled Matplotlib yourself, please also provide: | ||
| 357 | + | ||
| 358 | + * any changes you have made to ``setup.py`` or ``setupext.py``. | ||
| 359 | + * the output of:: | ||
| 360 | + | ||
| 361 | + rm -rf build | ||
| 362 | + python setup.py build | ||
| 363 | + | ||
| 364 | + The beginning of the build output contains lots of details about your | ||
| 365 | + platform that are useful for the Matplotlib developers to diagnose your | ||
| 366 | + problem. | ||
| 367 | + | ||
| 368 | + * your compiler version -- e.g., ``gcc --version``. | ||
| 369 | + | ||
| 370 | + Including this information in your first e-mail to the mailing list | ||
| 371 | + will save a lot of time. | ||
| 372 | + | ||
| 373 | + You will likely get a faster response writing to the mailing list than | ||
| 374 | + filing a bug in the bug tracker. Most developers check the bug | ||
| 375 | + tracker only periodically. If your problem has been determined to be | ||
| 376 | + a bug and cannot be quickly solved, you may be asked to file a bug in | ||
| 377 | + the tracker so the issue doesn't get lost. | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments