Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding doc building instructions #101

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Apex Documentation

## Make the docs locally

### Tool Installation

In order to build the documentation in this folder, you need ot have Sphinx-doc installed. Follow the [instructions here](https://www.sphinx-doc.org/en/master/usage/installation.html) for your specific OS.

For example, on Debian/Ubuntu:

apt-get install python3-sphinx

For OSX:

brew install sphinx-doc

Anaconda

conda install sphinx

Document building also requires make and dev tools.

### Build the docs

Once installed, you can use the make command to build the docs, for help simply type `make` in the `docs` director

cd docs
make

For an example, if you wanted to build the docs as HTML, you would use

make html

After running this command you should see "Build finished. The HTML pages are in build/html." To view your docs you can simply open them with a browser:

cd html

and then open `index.html` in your browser.