Changes to README and addition of index files for HTML and MD format …

…Sphinx-generated docs.
osamja · Jan 24, 2022 · 3bdaab8 · 3bdaab8
1 parent 8a5b835
commit 3bdaab8
Show file tree

Hide file tree

Showing 7 changed files with 1,540 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -21,4 +21,14 @@ these docs just do `make html` in this directory. The generated docs are static
 though they can certainly be hosted on one. You can view them by just going
 directly to the main HTML file itself at `./sphinx/build/html/index.html`. The template
 file for the index page is `index.rst` located in this directory. You can
-change themes and many other parameters by editing `./sphinx/config/conf.py`
+change themes and many other parameters by editing `./sphinx/config/conf.py`
+
+The docs are now also here in Markdown format. To regenerate the Markdown docs you must
+install the [sphinx-markdown-builder](https://pypi.org/project/sphinx-markdown-builder/)
+using `pip3 install sphinx-markdown-builder`
+
+These are the links this documentation hosted here on Github.
+
+[HTML format documentation](sphinx/build/html/index.html 'HTML docs')
+
+[Markdown format documentation](sphinx/build/markdown/index.md 'Markdown docs')
diff --git a/index.rst b/index.rst
@@ -5,8 +5,7 @@
 
 Welcome to Vast.ai's documentation!
 ===================================
-To regenerate after making changes cd to the main "``vast-python``"
-directory and run "``sphinx-build -c sphinx/config/ -b html . sphinx/build/``"
+
 
 .. toctree::
    :maxdepth: 2

diff --git a/sphinx/build/html/index.html b/sphinx/build/html/index.html