Commit c5a64688 authored by Carlos Torres's avatar Carlos Torres

Updating README and deploy.sh

parent 00a3c372
......@@ -7,7 +7,7 @@ Includes info about:
- sc_pack,
- ShimmerCat server for the accelerator
Note that the documenation is structured around four different functions: *tutorials, how-to guides, explanation* and *technical reference*, based on the tips in https://www.divio.com/blog/documentation/.
Note that the documenation is structured around four different functions: *tutorials, how-to guides, explanation* and *technical reference*, based on the tips in https://www.divio.com/blog/documentation/.
## How to create a static website for the docs?
......@@ -24,7 +24,10 @@ Install the requirements:
- $ pip install -r requirements.txt
We use [MkDocs](https://www.mkdocs.org/) to generate the static site from the `.md` files. Take a look to the `mkdocs.yml` we have on the same directory this file is.
### We use two variants to generate the static site from the `.md` files.
1. We use [MkDocs](https://www.mkdocs.org/) to generate the static site from the `.md` files. Take a look to the `mkdocs.yml` we have on the same directory this file is.
To run the docs server locally use:
......@@ -34,3 +37,12 @@ Open up http://127.0.0.1:8000/ in your browser, and you'll see the index page be
If you want to know more details about how to use the MkDocs, please visit https://www.mkdocs.org/.
2. We use [Sphinx](https://www.sphinx-doc.org), take a look to the `docs/contents.rst` file.
We have developed our own theme (`shimmercat_qs_docs_sphinx_theme`), very similar to [pytorch_sphinx_theme](https://github.com/pytorch/pytorch_sphinx_theme).
To generate the static files:
- $ cd docs
- $ make html
The generated files will be in `docs/build/html` folder. You can open them directly in the browser or use the server of your choice.
Compiling the course documentation
## How to create a static website for the ShimmerCat docs?
We highly recommend to create a python virtual environment.
- $ virtualenv venv -p python3
Activate the virtual environment:
- $ source venv/bin/activate
Install the requirements:
- $ pip install -r requirements.txt
### We use two variants to generate the static site from the `.md` files.
1. We use [MkDocs](https://www.mkdocs.org/), take a look to the `mkdocs.yml` we have on the same directory this file is.
To run the docs server locally use:
- $ mkdocs serve
Open up http://127.0.0.1:8000/ in your browser, and you'll see the index page being displayed.
If you want to know more details about how to use the MkDocs, please visit https://www.mkdocs.org/.
2. We use [Sphinx](https://www.sphinx-doc.org), take a look to the `docs/contents.rst` file.
We have developed our own theme (`shimmercat_qs_docs_sphinx_theme`), very similar to [pytorch_sphinx_theme](https://github.com/pytorch/pytorch_sphinx_theme).
To generate the static files:
- $ cd docs
- $ make html
The generated files will be in `docs/build/html` folder. You can open them directly in the browser or use the server of your choice.
......@@ -11,6 +11,6 @@ mkdocs build --clean
cd "$CURRENT_DIR/docs"
make html
deactivate
${VENV_BIN}/sc_pack ctl restart shimmercat
deactivate
\ No newline at end of file
sudo systemctl restart sc-deployment_docs_accelerator
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment