You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/10/21 12:23:08 UTC
[GitHub] [arrow] amol- commented on a change in pull request #11464: ARROW-14384: [Docs] Add documentation for building Sphinx docs without having to build pyarrow
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
--
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-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org