Skip to content

Commit

Permalink
Fix velox/docs/README.md (facebookincubator#8891)
Browse files Browse the repository at this point in the history
Summary:
Addresses facebookincubator#8889

Pull Request resolved: facebookincubator#8891

Reviewed By: mbasmanova

Differential Revision: D54433004

Pulled By: kgpai

fbshipit-source-id: 5133b82624be63489c2fafdb7f26369078320ce2
  • Loading branch information
acvictor authored and facebook-github-bot committed Mar 15, 2024
1 parent 03d017f commit 925cef0
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 52 deletions.
43 changes: 0 additions & 43 deletions scripts/gen-docs.sh

This file was deleted.

11 changes: 2 additions & 9 deletions velox/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,9 @@ To install Sphinx: `easy_install -U sphinx`

`sphinx-quickstart` command was used to generate the initial Makefile and config.

### Building PyVelox Components

If you're using a conda environment, it can be easily installed by `conda install` command.

Pandoc is also used to generate `.rst` files from existing markdown files. Refer to installation
instructions [here](https://pandoc.org/installing.html).

To build the documentation, e.g. generate HTML files from .rst files:

Run the `./scripts/gen-docs.sh` script from the base directory.
Run `make html` from velox/docs.

Navigate to
`velox/docs/_build/html/index.html` in your browser to view the documentation.
Expand All @@ -39,7 +32,7 @@ directory to the top-level docs folder and push to gh-pages branch.
git checkout -b update-docs main
# Generate the documentation.
./scripts/gen-docs.sh
cd velox/docs && make html
# Copy documentation files to the top-level docs folder.
cp -R _build/html/* ../../docs
Expand Down

0 comments on commit 925cef0

Please sign in to comment.