updated docs: part 1

compas-dev · Dec 5, 2023 · d357af1 · d357af1
1 parent 25bf4f7
commit d357af1
Show file tree

Hide file tree

Showing 89 changed files with 2,390 additions and 2,640 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -1,5 +1,4 @@
 # EditorConfig is awesome: http://EditorConfig.org
-
 root = true
 
 [*]
@@ -9,21 +8,20 @@ insert_final_newline = true
 indent_style = space
 indent_size = 4
 charset = utf-8
-max_line_length = 120
+max_line_length = 180
 
 [*.{bat,cmd,ps1}]
 end_of_line = crlf
 
 [*.md]
 trim_trailing_whitespace = false
 
+[*.yml]
+indent_size = 2
+
 [Makefile]
 indent_style = tab
 indent_size = 4
 
-[*.yml]
-indent_style = space
-indent_size = 2
-
 [LICENSE]
 insert_final_newline = false
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,4 +18,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
-* Support for python below 3.8
+* Support for python below 3.8
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,61 +1,3 @@
 # Contributing
 
-Contributions are welcome and very much appreciated!
-
-
-## Code contributions
-
-We accept code contributions through pull requests.
-In short, this is how that works.
-
-1. Fork [the repository](https://github.com/compas-dev/compas_fea2) and clone the fork.
-2. Create a virtual environment using your tool of choice (e.g. `virtualenv`, `conda`, etc).
-3. Install development dependencies:
-
-```bash
-    $ pip install -r requirements-dev.txt
-```
-
-4. Make sure all tests pass:
-
-```bash
-    $ invoke test
-```
-
-5. Start making your changes to the **master** branch (or branch off of it).
-6. Make sure all tests still pass:
-
-```bash
-    $ invoke test
-```
-
-7. Add yourself to the *Contributors* section of `AUTHORS.md`.
-8. Commit your changes and push your branch to GitHub.
-9. Create a [pull request](https://help.github.com/articles/about-pull-requests/) through the GitHub website.
-
-
-During development, use [pyinvoke](http://docs.pyinvoke.org/) tasks on the
-command line to ease recurring operations:
-
-* `invoke clean`: Clean all generated artifacts.
-* `invoke check`: Run various code and documentation style checks.
-* `invoke docs`: Generate documentation.
-* `invoke test`: Run all tests and checks in one swift command.
-* `invoke`: Show available tasks.
-
-
-## Bug reports
-
-When [reporting a bug](https://github.com/compas-dev/compas_fea2/issues) please include:
-
-* Operating system name and version.
-* Any details about your local setup that might be helpful in troubleshooting.
-* Detailed steps to reproduce the bug.
-
-
-## Feature requests
-
-When [proposing a new feature](https://github.com/compas-dev/compas_fea2/issues) please include:
-
-* Explain in detail how it would work.
-* Keep the scope as narrow as possible, to make it easier to implement.
+Coming soon...
diff --git a/docs/_images/CollaborationWorkflow.jpg b/docs/_images/CollaborationWorkflow.jpg
diff --git a/docs/_images/CollaborationWorkflow_example.jpg b/docs/_images/CollaborationWorkflow_example.jpg
diff --git a/docs/_images/examples/principal_stress_cantilever.png b/docs/_images/examples/principal_stress_cantilever.png
diff --git a/docs/_images/examples/principal_stress_script.png b/docs/_images/examples/principal_stress_script.png
diff --git a/docs/_images/fork.png b/docs/_images/fork.png
diff --git a/docs/_images/workflow_1.png b/docs/_images/workflow_1.png
diff --git a/docs/_images/workflow_2.jpg b/docs/_images/workflow_2.jpg
diff --git a/docs/_static/compas.css b/docs/_static/compas.css
@@ -0,0 +1,30 @@
+html[data-theme="light"] {
+    --pst-color-primary: #0092d2;
+    --pst-color-info: #0092d2;
+    --pst-color-text-muted: #888;
+}
+
+body {
+    line-height: 1.75;
+    font-weight: 300;
+}
+
+.bd-article-container h1 {
+    color: #0092d2;
+}
+
+.navbar-brand .logo__image {
+    height: 36px !important;
+}
+
+.bd-header {
+    box-shadow: none;
+    border-bottom: 1px solid var(--pst-color-shadow);
+}
+
+#rtd-footer-container {
+    height: 0px;
+    bottom: 0 !important;
+    margin: 0 !important;
+    display: none;
+}
diff --git a/docs/_static/compas.ico b/docs/_static/compas.ico
diff --git a/docs/_static/compas_icon.png b/docs/_static/compas_icon.png
diff --git a/docs/_static/compas_icon_white.png b/docs/_static/compas_icon_white.png
diff --git a/docs/_static/compas_white.ico b/docs/_static/compas_white.ico
diff --git a/docs/_static/versions.json b/docs/_static/versions.json
@@ -0,0 +1,7 @@
+[
+    {
+        "name": "latest",
+        "version": "unreleased",
+        "url": "https://compas.dev/compas_libigl/latest/"
+    }
+]
diff --git a/docs/_templates/PLACEHOLDER b/docs/_templates/PLACEHOLDER
diff --git a/docs/_templates/autosummary/base.rst b/docs/_templates/autosummary/base.rst
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
diff --git a/docs/_templates/autosummary/method.rst b/docs/_templates/autosummary/method.rst
diff --git a/docs/_templates/autosummary/module.rst b/docs/_templates/autosummary/module.rst
diff --git a/docs/_templates/compas-sidebar-footer.html b/docs/_templates/compas-sidebar-footer.html
@@ -0,0 +1,5 @@
+<div class="sidebar-primary-item">
+    <a href="https://compas.dev" target="_blank">
+        COMPAS.dev <i class="fa fa-external-link" aria-hidden="true"></i>
+    </a>
+</div>
diff --git a/docs/_templates/navbar-nav.html b/docs/_templates/navbar-nav.html
@@ -0,0 +1,11 @@
+<nav class="navbar-nav">
+  <!-- <p class="sidebar-header-items__title"
+     role="heading"
+     aria-level="1"
+     aria-label="{{ _('Site Navigation') }}">
+    {{ _("Site Navigation") }}
+  </p>
+  <ul class="bd-navbar-elements navbar-nav">
+    {{ generate_header_nav_html(n_links_before_dropdown=theme_header_links_before_dropdown) }}
+  </ul> -->
+</nav>
diff --git a/docs/_templates/sbt-sidebar-nav.html b/docs/_templates/sbt-sidebar-nav.html
@@ -0,0 +1,24 @@
+<nav class="bd-links" id="bd-docs-nav" aria-label="Main">
+    <div class="bd-toc-item navbar-nav active">
+        {% if theme_home_page_in_toc == True %}
+        {#- This mimicks the pydata theme list style so we can append an extra item at the top #}
+        <ul class="nav bd-sidenav bd-sidenav__home-link">
+            <li class="toctree-l1{% if pagename == root_doc %} current active{% endif %}">
+                <a class="reference internal" href="{{ pathto(root_doc) }}">
+                    {{ root_title }}
+                </a>
+            </li>
+        </ul>
+        {% endif -%}
+
+        {# Ref: https://github.com/pydata/pydata-sphinx-theme/blob/ebf7f704879a1cdc6016d6111062103353ac7677/src/pydata_sphinx_theme/__init__.py#L302 #}
+        {{- generate_toctree_html(
+            startdepth=0,
+            kind="sidebar",
+            maxdepth=theme_navigation_depth,
+            collapse=False,
+            includehidden=True,
+            titles_only=True,
+            show_nav_level=1) }}
+    </div>
+</nav>
diff --git a/docs/advanced.backends.rst b/docs/advanced.backends.rst
@@ -0,0 +1,3 @@
+******************
+Advanced: Backends
+******************
diff --git a/docs/advanced.results.rst b/docs/advanced.results.rst
@@ -0,0 +1,3 @@
+*****************
+Advanced: Results
+*****************
diff --git a/docs/advanced.visualisation.rst b/docs/advanced.visualisation.rst
@@ -0,0 +1,3 @@
+***********************
+Advanced: Visualisation
+***********************
diff --git a/docs/api/compas_fea2.UI.rst b/docs/api/compas_fea2.UI.rst
diff --git a/docs/api/compas_fea2.job.rst b/docs/api/compas_fea2.job.rst
@@ -1,2 +1,11 @@
+********************************************************************************
+job
+********************************************************************************
 
-.. automodule:: compas_fea2.job
+.. currentmodule:: compas_fea2.job
+
+.. autosummary::
+    :toctree: generated/
+
+    InputFile
+    ParametersFile
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,4 +18,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

		### Removed

		* Support for python below 3.8
		* Support for python below 3.8