From 38653579a12a785917126265b1a3bfb686a1fa8d Mon Sep 17 00:00:00 2001 From: Jessica Greene Date: Fri, 28 Jul 2023 17:58:44 +0000 Subject: [PATCH 1/3] update gitpod docs and small fix --- doc/source/development/contributing_gitpod.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/source/development/contributing_gitpod.rst b/doc/source/development/contributing_gitpod.rst index 042a2f316cd42..9e0fe7f705d55 100644 --- a/doc/source/development/contributing_gitpod.rst +++ b/doc/source/development/contributing_gitpod.rst @@ -77,6 +77,7 @@ repository: $ python -m pytest pandas + Note that this command takes a while to run, so once you've confirmed it's running you may want to cancel it using ctrl-c. Quick workspace tour -------------------- @@ -138,9 +139,9 @@ Rendering the pandas documentation ---------------------------------- You can find the detailed documentation on how rendering the documentation with Sphinx works in the :ref:`contributing.howto-build-docs` section. To build the full -docs you need to run the following command in the docs directory:: +docs you need to run the following command in the :ref:`/doc` directory:: - $ cd docs + $ cd doc $ python make.py html Alternatively you can build a single page with:: From ccfa350205990c01590090531693db0626112eed Mon Sep 17 00:00:00 2001 From: Jessica Greene Date: Fri, 28 Jul 2023 18:08:14 +0000 Subject: [PATCH 2/3] remove ref from /doc --- doc/source/development/contributing_gitpod.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing_gitpod.rst b/doc/source/development/contributing_gitpod.rst index 9e0fe7f705d55..2bffd60e1e0d4 100644 --- a/doc/source/development/contributing_gitpod.rst +++ b/doc/source/development/contributing_gitpod.rst @@ -139,7 +139,7 @@ Rendering the pandas documentation ---------------------------------- You can find the detailed documentation on how rendering the documentation with Sphinx works in the :ref:`contributing.howto-build-docs` section. To build the full -docs you need to run the following command in the :ref:`/doc` directory:: +docs you need to run the following command in the /doc directory:: $ cd doc $ python make.py html From 0fa1d5ef66d4fbfc7ff4da9f77396f9ed47d183a Mon Sep 17 00:00:00 2001 From: Jessica Greene Date: Sun, 30 Jul 2023 15:33:55 +0200 Subject: [PATCH 3/3] Update doc/source/development/contributing_gitpod.rst add backticks for directory reference Co-authored-by: Noa Tamir <6564007+noatamir@users.noreply.github.com> --- doc/source/development/contributing_gitpod.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing_gitpod.rst b/doc/source/development/contributing_gitpod.rst index 2bffd60e1e0d4..2ba43a44b87d3 100644 --- a/doc/source/development/contributing_gitpod.rst +++ b/doc/source/development/contributing_gitpod.rst @@ -139,7 +139,7 @@ Rendering the pandas documentation ---------------------------------- You can find the detailed documentation on how rendering the documentation with Sphinx works in the :ref:`contributing.howto-build-docs` section. To build the full -docs you need to run the following command in the /doc directory:: +docs you need to run the following command in the ``/doc`` directory:: $ cd doc $ python make.py html