Skip to content

Commit

Permalink
Updated docs for 0.6.6 release.
Browse files Browse the repository at this point in the history
Signed-off-by: Devansh Agarwal <[email protected]>
  • Loading branch information
devanshkv committed Nov 13, 2021
1 parent c6c94f0 commit 7bea8bf
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 14 deletions.
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@
[![codecov](https://codecov.io/gh/thepetabyteproject/your/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/thepetabyteproject/your)
![Python package](https://github.com/thepetabyteproject/your/workflows/Python%20package/badge.svg?style=flat-square)
[![status](https://joss.theoj.org/papers/798844ebd352f563de28bb75515da674/status.svg?style=flat-square)](https://joss.theoj.org/papers/798844ebd352f563de28bb75515da674)

<!--
[![HitCount](http://hits.dwyl.com/devanshkv/your.svg)](http://hits.dwyl.com/devanshkv/your)
-->

</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +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
- `mike deploy {version} latest` # put value in {version} and make it the latest version
- `mike deploy {version} latest --update-aliases` # put value in {version} and make it the latest version
- `mike set-default --push latest` # To deploy the docs online

16 changes: 16 additions & 0 deletions docs/autogen.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,20 @@
from keras_autodoc import DocumentationGenerator
from mdutils.mdutils import MdUtils


def remove_html(filename):
"""
Read file and delete matching html tags
"""
with open(filename, "r") as f:
lines = f.readlines()
with open(filename, "w") as f:
for line in lines:
if ("<" in line) or (">" in line):
continue
f.write(line)


pages = {
"your.md": [
"your.Your",
Expand Down Expand Up @@ -117,6 +131,8 @@
shutil.copyfile("../CODE_OF_CONDUCT.md", "sources/CODE_OF_CONDUCT.md")
shutil.copyfile("../CONTRIBUTING.md", "sources/CONTRIBUTING.md")

remove_html("sources/index.md")

# Make the dir for tutorials
os.mkdir("sources/ipynb")
for nb in glob.glob("../examples/*ipynb"):
Expand Down
9 changes: 4 additions & 5 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ plugins:
- search
- mkdocs-jupyter:
include_source: True
execute: False
execute: True

markdown_extensions:
- codehilite
Expand All @@ -64,11 +64,10 @@ markdown_extensions:
emoji_generator: !!python/name:materialx.emoji.to_svg
- admonition

google_analytics:
- UA-167281386-1
- auto

extra:
analytics:
provider: google
property: UA-167281386-1
version:
provider: mike
social:
Expand Down
8 changes: 4 additions & 4 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
keras-autodoc>=0.7.0
mkdocs>=1.1.2
mkdocs-material>=7.1.3
mkdocs>=1.2.3
mkdocs-material>=6.2.7
argmark>=0.3
mkdocs-jupyter>=0.16.1
mike>=1.0.0
mkdocs-jupyter>=0.18.2
mike>=1.1.2

0 comments on commit 7bea8bf

Please sign in to comment.