amol- commented on a change in pull request #11464:
URL: https://github.com/apache/arrow/pull/11464#discussion_r733619645
##########
File path: docs/source/developers/documentation.rst
##########
@@ -101,3 +101,27 @@ 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 first installing `sphinx`:
+
+.. code-block:: shell
+
+ pip install sphinx
+
+and then navigating to the appropriate directory and running:
+
+.. code-block:: shell
+
+ sphinx-quickstart
Review comment:
I don't think you want to run this, that will create a new sphinx
project and thus will leave on your disk a bunch of files that shouldn't be
part of the documenation like extra `index.rst` files, extra `conf.py` files
and so on.
Als I think that if the directory already has an `index.rst` you will end up
replacing it with an empty one at the risk of committing a broken index
##########
File path: docs/source/developers/documentation.rst
##########
@@ -101,3 +101,27 @@ 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
Review comment:
By single directory you mean a piece of the docs? Like building only the
`format` or `python` directories?
In such case I think that what you are looking for is `sphinx-build
source/python _build -c source` (for example if you only want to build the
Python directory).
Notice that for that to work, it requires the directory to have its own
`index.rst` file for the command to work.
--
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
