Skip to content

Commit

Permalink
Update local build instructions to remove Python version
Browse files Browse the repository at this point in the history
  • Loading branch information
zlovatt committed Aug 24, 2021
1 parent 5755d75 commit c421bb0
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@ Things to note:

---

## Building Locally
## Build HTML Locally

- Run `make html` in the project directory
- The project will be built in a subfolder at `_build/html` where you can open index.html in a browser as expected
- Any issues / warnings will be displayed in the console
You may want to build the HTML locally before pushing, in order to ensure that the result is what you'd expect. These files aren't included in the git repo, nor are they used online; this is solely to create a local, offline version of the online docs.

- Install ``Python``
- Install ``pip``
- Navigate to the project directory and use the command ``pip install -r requirements.txt``
- Build the docs using ``make html``

---

Expand Down
6 changes: 5 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,4 +210,8 @@
# -------------------------------------------------------------------------

def setup(app):
app.add_stylesheet("theme_overrides.css") # Fix table wrapping
try:
app.add_stylesheet("theme_overrides.css")

except:
app.add_css_file("theme_overrides.css")

0 comments on commit c421bb0

Please sign in to comment.