amol- commented on a change in pull request #11464:
URL: https://github.com/apache/arrow/pull/11464#discussion_r734611760
##########
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
Review comment:
I'm not sure why we would have to move away the existing index, if the
index already exists doesn't that make us happy and we can just build with the
existing index?
Anyway, I think it would be wise to pass `-Dmaster_doc=tmpindex` to
`sphinx-build` instead of renaming the index file. That way you can create and
build using a `tmpindex.rst` instead of messing with the existing `index.rst`
which will be ignored.
--
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]
