Skip to content

Add instructions on how to build HTML from RST using sphinx-build #1

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.

Sign up for GitHub

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

Open
mdwheele wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add instructions on how to build HTML from RST using sphinx-build #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ Thumbs.db
###############
_build
build

# Python Virtual Environment
.venv
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Python Flask API Lab

Content used for lab generation on HoW.

## Building the Site

```
# Set up a Python 3 virtual environment to install dependencies to...
> python3 -m venv .venv

# Activate the venv
> source .venv/bin/activate

# Install dependencies from requirements.txt...
> pip install -r requirements.txt

# Use sphinx to build the site...
> sphinx-build . _build
```
4 changes: 0 additions & 4 deletions README.rst
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
sphinxcontrib-fulltoc == 1.2.0
sphinx-bootstrap-theme == 0.6.0
sphinx_fontawesome
sphinx