alamb commented on a change in pull request #993:
URL: https://github.com/apache/arrow-datafusion/pull/993#discussion_r707547538
##########
File path: docs/README.md
##########
@@ -17,15 +17,19 @@
under the License.
-->
-# DataFusion User Guide Source
+# DataFusion docs
-This directory contains the sources for the DataFusion user guide.
+## Dependencies
-## Generate HTML
+It's recommended to install build dependencies and build the the documentation
+inside a Python virtualenv.
-To generate the user guide in HTML format, run the following commands:
+- Python
+- `pip install -r requirements.txt`
+- Datafusion python package. You can install the latest version by running
`maturin develop` inside `../python` directory.
Review comment:
I tried these instructions locally and one other thing I had to do was
to run `pip install maturin` in my venv to be able to run `maturn develop`
So perhaps we should also suggest adding `pip install maturin` alongside
`maturin develop`
--
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]
