📝 RTD initial release

mraniki · Aug 3, 2023 · b4487d1 · b4487d1
1 parent 16f181c
commit b4487d1
Show file tree

Hide file tree

Showing 15 changed files with 349 additions and 266 deletions.
diff --git a/docs/01_start.rst b/docs/01_start.rst
@@ -0,0 +1,23 @@
+===============
+Getting Started
+===============
+
+
+Installation
+============
+
+::
+    
+    pip install findmyorder
+
+
+Example
+=======
+
+The following example illustrate how to use the module
+
+
+.. rli:: https://raw.githubusercontent.com/mraniki/dxsp/main/dxsp/example.py
+    :language: python
+
+
diff --git a/docs/02_config.rst b/docs/02_config.rst
@@ -0,0 +1,13 @@
+
+======
+Config
+======
+
+
+Setting available via settings.toml or .env
+
+
+.. rli:: https://raw.githubusercontent.com/mraniki/findmyorder/main/findmyorder/default_settings.toml
+   :language: toml
+
+
diff --git a/docs/03_module.rst b/docs/03_module.rst
@@ -0,0 +1,11 @@
+
+======
+Module
+======
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   findmyorder
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -0,0 +1,26 @@
+/* 
+#073BD9
+#05C7F2
+#05F2F2
+#F2DA63
+#F2E6A7
+*/
+
+
+:root {
+--body-bg: #292929;
+--body-color: #E2E8E4;
+}
+
+.navbar-inverse, .navbar-collapse,  .navbar-brand:hover, .navbar-default, .navbar-inverse .navbar-brand:focus, .navbar-inverse .navbar-nav > li > a:hover, .navbar-inverse .navbar-nav > li > a:focus {
+    background-color: #222222;
+  }
+
+  a {
+    color: #ffcc00;
+  }
+  a:hover {
+    color: #ffcc00; ;
+  }
+
+
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
diff --git a/docs/_static/favicon.png b/docs/_static/favicon.png
diff --git a/docs/_static/logo-full.png b/docs/_static/logo-full.png
diff --git a/docs/_templates/custom-class-template.rst b/docs/_templates/custom-class-template.rst
@@ -0,0 +1,34 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+   {% block methods %}
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% for item in methods %}
+      {%- if not item.startswith('_') %}
+      ~{{ name }}.{{ item }}
+      {%- endif -%}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
diff --git a/docs/_templates/custom-module-template.rst b/docs/_templates/custom-module-template.rst
@@ -0,0 +1,66 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+      :nosignatures:
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. autosummary::
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}
diff --git a/docs/_templates/navbar.html b/docs/_templates/navbar.html
@@ -0,0 +1,105 @@
+<div id="navbar" class="{{ theme_navbar_class }} navbar-default {% if theme_navbar_fixed_top|tobool -%} navbar-fixed-top{%- endif -%}">
+    <div class="container">
+      <div class="navbar-header">
+        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
+        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </button>
+        <a class="navbar-brand" href="{{ pathto(master_doc) }}" style="padding: 12px;">
+          {%- block sidebarlogo %}
+            {%- if logo %}
+              <span>
+                <img src="{{ pathto('_static/' + logo, 1) }}" class="logo">
+                <!-- <img src="{{ pathto('_static/alt-' + logo, 1) }}" class="logo-hover"> -->
+              </span>
+            {%- endif %}
+          {%- endblock %}
+        </a>
+      </div>
+
+        <div class="collapse navbar-collapse nav-collapse">
+          <ul class="nav navbar-nav">
+            {% if theme_navbar_links %}
+              {%- for menu in theme_navbar_links %}
+                {% if menu[0] == "_menu" %}
+                  <li class="dropdown">
+                    <a role="button" id="{{ menu[1] }}Toc" data-toggle="dropdown" data-target="#" href="#" aria-expanded="false">{{ menu[1] }} <b class="caret"></b></a>
+                    <ul class="dropdown-menu multi-level" role="menu" aria-labelledby="{{ menu[1] }}Toc">
+                    {%- for link in menu[2] %}
+                      {% if link[0] == "_divider" %}
+                        <li class="divider"></li>
+                      {% elif link[0] == "_menu" %}
+                        <li class="dropdown-submenu">
+                          {% if link|length == 4 %}
+                            <a tabindex="-1" href="{{ pathto(link[2]) }}">{{ link[1] }}</a>
+                          {% elif link|length == 5 %}
+                            <a tabindex="-1" href="{{ pathto(link[2]) }}{{ link[3] }}">{{ link[1] }}</a>
+                          {% else %}
+                            <a tabindex="-1" href="#">{{ link[1] }}</a>
+                          {% endif %}
+                          <ul class="dropdown-menu">
+                            {%- for sublink in link[-1] %}
+                              {% if sublink[0] == "_divider" %}
+                                <li class="divider"></li>
+                              {% elif sublink[0] == "_menu" %}
+                                <li class="dropdown-submenu">
+                                  {% if sublink|length == 4 %}
+                                    <a tabindex="-1" href="{{ pathto(sublink[2]) }}">{{ sublink[1] }}</a>
+                                  {% elif sublink|length == 5 %}
+                                    <a tabindex="-1" href="{{ pathto(sublink[2]) }}{{ sublink[3] }}">{{ sublink[1] }}</a>
+                                  {% else %}
+                                    <a tabindex="-1" href="#">{{ sublink[1] }}</a>
+                                  {% endif %}
+                                  <ul class="dropdown-menu">
+                                    {%- for specificlink in sublink[-1] %}
+                                      {% if specificlink[0] == "_divider" %}
+                                        <li class="divider"></li>
+                                      {% elif specificlink|length > 2 %}
+                                        <li><a href="{{ pathto(specificlink[1]) }}{{ specificlink[2] }}">{{ specificlink[0] }}</a></li>
+                                      {% else %}
+                                        <li><a href="{{ specificlink[1] if specificlink[1][:4] == 'http' else pathto(specificlink[1]) }}">{{ specificlink[0] }}</a></li>
+                                      {% endif %}
+                                    {%- endfor %}
+                                  </ul>
+                                </li>
+                              {% elif sublink|length > 2 %}
+                                <li><a href="{{ pathto(sublink[1]) }}{{ sublink[2] }}">{{ sublink[0] }}</a></li>
+                              {% else %}
+                                <li><a href="{{ sublink[1] if sublink[1][:4] == 'http' else pathto(sublink[1]) }}">{{ sublink[0] }}</a></li>
+                              {% endif %}
+                            {%- endfor %}
+                          </ul>
+                        </li>
+                      {% elif link|length > 2 %}
+                        <li><a href="{{ pathto(link[1]) }}{{ link[2] }}">{{ link[0] }}</a></li>
+                      {% else %}
+                        <li><a href="{{ link[1] if link[1][:4] == 'http' else pathto(link[1]) }}">{{ link[0] }}</a></li>
+                      {% endif %}
+                    {%- endfor %}
+                    </ul>
+                  </li>
+                {% else %}
+                  <li><a href="{{ pathto(*menu[1:]) }}">{{ menu[0] }}</a></li>
+                {% endif %}
+              {%- endfor %}
+            {% endif %}
+            {% if theme_navbar_sidebarrel %}
+              {% block sidebarrel %}
+                {% include "relations.html" %}
+              {% endblock %}
+            {% endif %}
+            {% block navbarextra %}
+            {% endblock %}
+            {% if theme_source_link_position == "nav" %}
+              <li class="hidden-sm">{% include "sourcelink.html" %}</li>
+            {% endif %}
+          </ul>
+
+          {% block navbarsearch %}
+            {% include "navbarsearchbox.html" %}
+          {% endblock %}
+        </div>
+    </div>
+  </div>