Skip to content

Commit

Permalink
Added documentation versioning
Browse files Browse the repository at this point in the history
Signed-off-by: Devansh Agarwal <[email protected]>
  • Loading branch information
devanshkv committed Apr 25, 2021
1 parent 270254a commit d68cca6
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 4 deletions.
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ Our documentation uses extended Markdown, as implemented by [MkDocs](http://mkdo
- `python autogen.py`
- `mkdocs serve` # Starts a local webserver: [localhost:8000](http://localhost:8000)
- `mkdocs build` # Builds a static site in `site/` directory
- `mkdocs gh-deploy` # To deploy the docs online
- `mike deploy {version} latest` # put value in {version} and make it the latest version
- `mike set-default --push latest` # To deploy the docs online

13 changes: 13 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ plugins:
- search
- mkdocs-jupyter:
include_source: True
execute: False

markdown_extensions:
- codehilite
Expand All @@ -66,3 +67,15 @@ markdown_extensions:
google_analytics:
- UA-167281386-1
- auto

extra:
version:
provider: mike
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/devanshkv
name: Devansh Agarwal on Twitter
- icon: fontawesome/brands/twitter
link: https://twitter.com/KshitijAgg13
name: Kshitij agarwal on Twitter

7 changes: 4 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
keras-autodoc>=0.7.0
mkdocs>=1.1.2
mkdocs-material>=6.2.7
argmark>=0.2
mkdocs-jupyter>=0.15.1
mkdocs-material>=7.1.3
argmark>=0.3
mkdocs-jupyter>=0.16.1
mike>=1.0.0

0 comments on commit d68cca6

Please sign in to comment.