From 81b7d5155f4add25309967bc13d5fb05c4121f71 Mon Sep 17 00:00:00 2001 From: Dustin Wheeler Date: Wed, 27 Apr 2022 17:09:32 -0400 Subject: [PATCH] Add instructions on how to build HTML from RST using sphinx-build --- .gitignore | 3 +++ README.md | 19 +++++++++++++++++++ README.rst | 4 ---- requirements.txt | 4 ++++ 4 files changed, 26 insertions(+), 4 deletions(-) create mode 100644 README.md delete mode 100644 README.rst create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore index 0bc0b95..207e5c9 100644 --- a/.gitignore +++ b/.gitignore @@ -40,3 +40,6 @@ Thumbs.db ############### _build build + +# Python Virtual Environment +.venv \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..e141987 --- /dev/null +++ b/README.md @@ -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 +``` \ No newline at end of file diff --git a/README.rst b/README.rst deleted file mode 100644 index 1d0e4bf..0000000 --- a/README.rst +++ /dev/null @@ -1,4 +0,0 @@ -Python Flask API Lab -#################### - -Content used for lab generation on HoW. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..cac0a12 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +sphinxcontrib-fulltoc == 1.2.0 +sphinx-bootstrap-theme == 0.6.0 +sphinx_fontawesome +sphinx \ No newline at end of file