thisisnic commented on a change in pull request #11464: URL: https://github.com/apache/arrow/pull/11464#discussion_r736316782
########## File path: docs/source/developers/documentation.rst ########## @@ -101,3 +101,51 @@ 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 ``docs`` directory, back up any existing ``index.rst`` +file in the target directory: + +.. code-block:: shell + + cd docs + mv ./source/developers/index.rst ./source/developers/index_old.rst + +Create an empty ``index.rst`` file: + +.. code-block:: shell + + touch ./source/developers/index.rst Review comment: Nevertheless, I have updated the instructions to do this now. -- 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: github-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org