diff --git a/Dockerfile b/Dockerfile index 8e1ced4f..ba00224d 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,7 +1,7 @@ FROM sphinxdoc/sphinx:latest as builder WORKDIR /netmaker-docs COPY . /netmaker-docs/ -RUN pip install sphinx_material +RUN pip install renku-sphinx-theme RUN ["make","html"] RUN ["/bin/ls"] diff --git a/README.md b/README.md index 5672b5af..3f01a617 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,14 @@ We encourage contributions! Follow the below documentation to build and make cha # How to build the Netmaker documentation -0. Install dependencies: make, python3, pip, sphinx, sphinx-material theme +0. Install dependencies: make, python3, pip, sphinx, renku-sphinx-theme ``` (debian instructions, varies by OS) apt-get install make apt-get install python3-sphinx apt-get install python3-pip -pip install git+https://github.com/bashtage/sphinx-material.git +pip install renku-sphinx-theme pip install markupsafe ``` diff --git a/_static/netmaker-custom.css b/_static/netmaker-custom.css new file mode 100644 index 00000000..8546e874 --- /dev/null +++ b/_static/netmaker-custom.css @@ -0,0 +1,70 @@ +/* .wy-nav-content { + max-width: 75% !important; +} */ +.wy-nav-content { + max-width: none; +} + +.wy-menu-vertical a { + background-color: #0f0d2d; + color: #fff; +} + +.wy-menu-vertical li.toctree-l2 a { + background-color: #0f0d2d; + color: #fff; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a { + background-color: #0f0d2d; + color: #fff; +} + +.wy-side-scroll { + background-color: #0f0d2d; +} + +.wy-nav-side { + background-color: #0f0d2d; +} + +.wy-side-nav-search { + background-color: #0f0d2d; +} + +.wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a { + background-color: #0f0d2d; + color: #d9d9d9 +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l4 > a:hover { + color: #fff +} + +.wy-menu-vertical li.toctree-l3.current li.toctree-l4.current > a { + background-color: #0f0d2d; + color: #fff +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a { + background-color: #0f0d2d; + color: #d9d9d9 +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3.current > a { + background-color: #0f0d2d; + color: #fff +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a:hover { + color: #fff +} + +.wy-menu-vertical li.current>a button.toctree-expand, .wy-menu-vertical li.on a button.toctree-expand { + background-color: #0f0d2d; + color: #d9d9d9 +} + +.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand, .wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand, .wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand, .wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand, .wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand, .wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand, .wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand, .wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand, .wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand { + color: #fff; +} diff --git a/conf.py b/conf.py index 1253b264..a496a7f6 100644 --- a/conf.py +++ b/conf.py @@ -22,7 +22,7 @@ author = 'Netmaker' # The full version, including alpha/beta/rc tags -release = '0.24.2' +release = '0.24.3' # -- General configuration --------------------------------------------------- @@ -47,27 +47,43 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_material' +html_theme = 'renku' html_show_sourcelink = False html_theme_options = { - 'nav_title': 'Netmaker Docs', - 'repo_url': 'https://github.com/gravitl/netmaker/', - "repo_name": "Netmaker", - 'nosidebar': True, - "repo_type": "github", - 'color_primary': 'blue', - 'color_accent': 'teal', - 'logo_icon': '', - 'globaltoc_depth': 2, + 'logo_only': True, + 'style_external_links': False, + 'titles_only': False, + 'display_version': True, +# 'github_url': 'https://github.com/gravitl/netmaker-docs', +# 'nav_title': 'Netmaker Docs', +# 'repo_url': 'https://github.com/gravitl/netmaker/', +# "repo_name": "Netmaker", + 'nosidebar': False, +# "repo_type": "github", +# 'color_primary': 'blue', +# 'color_accent': 'teal', +# 'logo_icon': '', +# 'globaltoc_depth': 2, 'globaltoc_collapse': True, } +html_static_path = [ + '_static' +] + +html_css_files = { + 'netmaker-custom.css' +} + html_sidebars = { "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"] } +html_logo = 'images/netmaker-teal.png' +#html_logo = 'https://cdn.prod.website-files.com/64149f8bba6c1301c5e75001/64149f8bba6c135dcee750af_netmaker%20logo%20old.svg' + # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". diff --git a/images/netmaker-teal.png b/images/netmaker-teal.png new file mode 100644 index 00000000..36989e9d Binary files /dev/null and b/images/netmaker-teal.png differ diff --git a/index.rst b/index.rst index c3e58c53..fea3833d 100644 --- a/index.rst +++ b/index.rst @@ -5,7 +5,7 @@ .. image:: images/netmaker.png - :width: 100% + :width: 70% :alt: Netmaker WireGuard :align: center diff --git a/nmctl.rst b/nmctl.rst index 2c81fb74..06bc8a82 100644 --- a/nmctl.rst +++ b/nmctl.rst @@ -8,6 +8,9 @@ NMCTL is a CLI tool for interacting with the Netmaker API. Quick Start ****************** +Setup +------ + Start with getting the latest nmctl binary specific to your operating system from the link below: .. code-block:: diff --git a/requirements.txt b/requirements.txt index e1eac84f..eb496eb1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1 @@ -sphinx-material +renku-sphinx-theme \ No newline at end of file