From a44ae26331849754f02cfc9ca9699f4e979d4561 Mon Sep 17 00:00:00 2001 From: "paul.profizi" Date: Tue, 8 Mar 2022 17:14:31 +0100 Subject: [PATCH] Doc: install.rst and contributing.rst now point to a common code snippet for cloning and installation (contributing page was outdated) --- docs/source/contributing.rst | 6 +----- docs/source/getting_started/install.rst | 6 +----- docs/source/pydpf-core_clone_install.rst | 5 +++++ 3 files changed, 7 insertions(+), 10 deletions(-) create mode 100644 docs/source/pydpf-core_clone_install.rst diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index 429d11bc03f..700217330e7 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -20,11 +20,7 @@ You can clone the source repository from `DPF-Core GitHub `_ and install the latest version in development mode by running: -.. code:: - - git clone https://github.com/pyansys/DPF-Core DPF-Core - cd DPF-Core - pip install -e . +.. include:: pydpf-core_clone_install.rst Questions diff --git a/docs/source/getting_started/install.rst b/docs/source/getting_started/install.rst index 27730bafddf..ffdb8310336 100644 --- a/docs/source/getting_started/install.rst +++ b/docs/source/getting_started/install.rst @@ -28,9 +28,5 @@ If you want to edit and potentially contribute to the DPF-Core module, clone the repository and install it using pip with the ``-e`` development flag: -.. code:: - - git clone https://github.com/pyansys/pydpf-core - cd pydpf-core - pip install -e . +.. include:: ../pydpf-core_clone_install.rst diff --git a/docs/source/pydpf-core_clone_install.rst b/docs/source/pydpf-core_clone_install.rst new file mode 100644 index 00000000000..6d5375d12da --- /dev/null +++ b/docs/source/pydpf-core_clone_install.rst @@ -0,0 +1,5 @@ +.. code:: + + git clone https://github.com/pyansys/pydpf-core + cd pydpf-core + pip install -e . \ No newline at end of file