amol- commented on a change in pull request #11464:
URL: https://github.com/apache/arrow/pull/11464#discussion_r734590836
##########
File path: docs/source/developers/documentation.rst
##########
@@ -101,3 +101,49 @@ The final output is located under ``docs/_build/html``.
.. seealso::
:ref:`docker-builds`.
+
+Building a single directory for dev purposes without all the pre-requisites
+----------------------------------------------------------
+
+You can build documentation in a single directory without needing to install
+all of the pre-requisites by installing sphinx, setting up a temporary
+index in the directory you want to build and then building that directory.
+
+The example below shows how to do this in the ``developers`` directory.
+
+Install ``sphinx``:
+
+.. code-block:: shell
+
+ pip install sphinx
+
+After navigating to the relevant directory, back up any existing ``index.rst``
file:
+
+.. code-block:: shell
+
+ cd docs/source/developers
+ mv index.rst index_old.rst
+
+Create an empty index.rst file:
+
+.. code-block:: shell
+
+ touch index.rst
+
+Build the current directory
+
+.. code-block:: shell
+
+ sphinx-build . _build -c ..
Review comment:
I think that this might be error prone, in the sense that `..` won't
always be the place where you have `conf.py`. I personally suggest you give the
instructions starting from the root folder so that they always work without
having to change the `_build` or conf directory relative path.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
