Initial folder structure for the documentation. A draft of documentation change has been made in the BertModel class.

This commit is contained in:
LysandreJik
2019-07-05 17:11:13 -04:00
parent e75c3f70aa
commit 03de9686a7
12 changed files with 2109 additions and 40 deletions

23
docs/README.md Normal file
View File

@@ -0,0 +1,23 @@
# Generating the documentation
To generate the documentation, you first have to build it. Building it requires the package `sphinx` that you can
install using:
```bash
pip install -U sphinx
```
You would also need the custom installed [theme](https://github.com/readthedocs/sphinx_rtd_theme) by
[Read The Docs](https://readthedocs.org/). You can install it using the following command:
```bash
pip install sphinx_rtd_theme
```
Once you have setup `sphinx`, you can build the documentation by running the following command in the `/docs` folder:
```bash
make html
```
It should build the static app that will be available under `/docs/_build/html`