diff options
author | MarsBarLee <mlee@quansight.com> | 2021-06-07 13:29:28 +0000 |
---|---|---|
committer | MarsBarLee <mlee@quansight.com> | 2021-06-08 18:33:31 +0000 |
commit | efaed1950223b5906dd751b04104b4b9191a929b (patch) | |
tree | 25593b6726cd35c05474f222f6b6663d09915689 /doc/source | |
parent | 3471e346e76ee0d9878d3fcae2c68bcf65798473 (diff) | |
download | numpy-efaed1950223b5906dd751b04104b4b9191a929b.tar.gz |
DOC: Add crosslink to Buildling the NumyP API and reference docs page
Diffstat (limited to 'doc/source')
-rw-r--r-- | doc/source/docs/howto_build_docs.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/source/docs/howto_build_docs.rst b/doc/source/docs/howto_build_docs.rst index 38ea1338c..8e6d7fe4f 100644 --- a/doc/source/docs/howto_build_docs.rst +++ b/doc/source/docs/howto_build_docs.rst @@ -16,6 +16,21 @@ in several different formats. .. _Sphinx: http://www.sphinx-doc.org/ +To build the documentation, you must first build NumPy. + +There are two options for building NumPy and its documentation- building with Gitpod or locally from source. Your choice depends on your operating system and familiarity with the command line. + +Gitpod +------------ +Gitpod is an open-source platform that automatically creates the correct development environment right in your browser, reducing the need to install local development environments and deal with incompatible dependencies. + +If you are a Windows user, unfamiliar with using the command line or building NumPy's documentation for the first time, it is often faster to build with Gitpod. Here are the in-depth instructions for building NumPy with `building NumPy with Gitpod`_. + +.. _building NumPy with Gitpod: https://numpy.org/devdocs/dev/development_gitpod.html + +Building locally +------------------ +Building locally on your machine gives you more granular control. If you are a MacOS or Linux user familiar with using the command line, you can continue with building NumPy locally by following the instructions below. Instructions ------------ |