Merge pull request #12 from nodedge/feature/website

Add website
nodedge · Oct 30, 2022 · ea9506e · ea9506e
2 parents d08c0b3 + 1b174f7
commit ea9506e
Show file tree

Hide file tree

Showing 97 changed files with 216 additions and 17 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,7 +16,7 @@ htmlcov/
 .mypy_cache
 venv/
 venv38/
-docs/build/
+docs_sphinx/build/
 dist/
 build/
 _template/

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -53,9 +53,9 @@ repos:
         types: [python]
         stages: [push]
         pass_filenames: false
-      - id: docs
-        name: run checks on docs building
-        entry: tox -e docs
+      - id: docs_sphinx
+        name: run checks on docs_sphinx building
+        entry: tox -e docs_sphinx
         language: system
         types: [python]
         stages: [push]

diff --git a/.travis.yml b/.travis.yml
@@ -59,7 +59,7 @@ jobs:
     - python: 3.10
       env: TOXENV=packaging
     - python: 3.10
-      env: TOXENV=docs
+      env: TOXENV=docs_sphinx
 
 
 before_script:

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -29,9 +29,9 @@ recursive-include tools *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
 
-recursive-include docs *.rst *.py Makefile make.bat *.png
-recursive-include docs/source/_templates *
-recursive-exclude docs/build *
+recursive-include docs_sphinx *.rst *.py Makefile make.bat *.png
+recursive-include docs_sphinx/source/_templates *
+recursive-exclude docs_sphinx/build *
 
 include *.txt
 recursive-include nodedge *

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/CNAME b/docs/CNAME
@@ -0,0 +1 @@
+www.nodedge.io
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,25 @@
+# What is Nodedge?
+
+Nodedge is a powerful graphical-programming environment designed by engineers for engineers. It lets you design multi-domain simulations by drag-and-dropping built-in graphic blocks.
+
+Nodedge is open-source, and it is written in Python, today's number one scripting language. It provides you with a Python command line, the possibility to customize your block, and generate Python code from your diagrams. Nodedge graphical interface is based on PySide6 to access to the complete Qt framework for next-generation user experience.
+
+Nodedge is multi-purpose. 
+Currently, Nodedge provides a graphical scripting environment with real-time evaluation.
+Our short-term goal is to provide support for **system design**, **simulation**, and **data plotting and analysis**. 
+Our mid-term goal is to add support for robotics-specific features, such as **embedded code generation** for common hardware platform, real-time data acquisition and inspection.
+
+</br>
+<center><img src="media/nodedge_interface.png" alt="nodedge_interface" width="500" /></center>
+
+# Getting started
+
+For getting started [download](https://github.com/nodedge/nodedge/releases/download/v0.2.3/NodedgeSetup.exe) our software or clone our repository from [Github](https://github.com/nodedge/nodedge).
+
+# Roadmap
+
+Nodedge is undergoing a major development phase. 
+We are working hard to provide you with unique features:
+* a versatile and customizable plotting environment for the analysis of time series
+* support of the most common data file format
+* a simulation environment for the simulation of physical models, chemical processes, robotic systems, and many others
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -0,0 +1,18 @@
+<!-- _coverpage.md -->
+
+<!-- ![logo](media/nodedge_logo.png) -->
+<img src="media/nodedge_logo.png" alt="logo" width="100"/>
+
+# Nodedge <small>0.2</small>
+
+> An open-source graphic environment for next-generation engineering.
+
+- Design. Simulate. Inspect.
+
+[Download](https://github.com/nodedge/nodedge/releases/download/v0.2.3/NodedgeSetup.exe)
+[GitHub](https://github.com/nodedge/nodedge)
+[Donate]()
+
+<!-- background color -->
+
+![color](#f0f0f0)
diff --git a/docs/_navbar.md b/docs/_navbar.md
@@ -0,0 +1,14 @@
+<!-- _navbar.md -->
+
+* [Home](/)
+* [Features](features.md)
+* [Resources](resources.md)
+* [About](about.md)
+
+<!--
+* Language
+
+    * [:us: EN](/)
+    * [:fr: FR](/fr/)
+    * [:it: IT](/it/)
+-->
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
diff --git a/docs/about.md b/docs/about.md
@@ -0,0 +1,33 @@
+# Our mission
+Nodedge's mission is to redefine the standards of scientific scripting and model-based design.
+Nodedge is the first **free and open-source** graphic environment for scientists and engineers.
+It is based on the **latest-generation technology** for a user experience that has never been so enjoyable.
+
+# Our vision
+Why should scientific knowledge be only for a few? By making Nodedge open source and free, we intend to
+**democratize knowledge**, **incentivize collaboration**, and give everyone the tool they deserve to create the
+**innovations of tomorrow**.
+
+# Meet our team
+
+<p style="text-align: center;">
+<font size="5"> <b>Enrica Soria</b> </font> <br />
+Developer and operations
+</p>
+
+<p style="text-align: center;">
+<font size="5"> <b>Anthony De Bortoli</b> </font> <br />
+Main developer
+</p>
+
+<p style="text-align: center;">
+<img src="media/pongy.jpg" alt="pongy" width="180"/> <br />
+<font size="5"> <b>Pongy</b> </font> <br />
+Our mascotte
+</p>
+
+# Our contacts
+
+**Address**: Lausanne (1005), Switzerland<br />
+**Email**: [admin@nodedge.io](mailto:admin@nodedge.io)<br />
+**Telephone**: (+41) 076 448 14 24
diff --git a/docs/features.md b/docs/features.md
@@ -0,0 +1,26 @@
+# Graphical programming
+Nodedge provides you with a complete environment for graphical programming. 
+Instead of writing complex lines of text code, you can focus on the logical flow 
+and create your program by simply combining built-in blocks, the *nodes* in a 
+diagram-like structure with *edges*. This modern paradigm
+allows you rapid prototyping, software testing, and verification.
+
+Nodes allow you to perform mathematical operations, simulate plants, process signals,
+design and reuse patterns, and perform many others. They can be easily dragged and drop
+from the node list, and configured to your needs. You can also create your own custom nodes
+and share them with other users.
+
+# Source code access
+Nodedge is the first scientific editor with source code access. Its code is freely accessible and auditable on Github.
+This allows the community to contribute, engage, audit, report and fix issues.
+Nodedge is written in Python3, the most popular scripting language.
+The graphics is based on Qt, the industry-leading framework for interfaces that users love.
+
+# Portability and collaboration
+
+Nodedge is cross-platform. You can install it on Windows, MacOS, and Linux.
+Nodedge project files are saved in a JSON format, which makes portability and versioning 
+easy. For next-level collaboration experience, we aim at making simultaneous editing possible.
+You and your colleagues will be able to access the same project, from anywhere, with no conflicts
+or latencies.
+
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+
+  <!-- Basic theme
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+  -->
+
+  <!-- Theme: Simple (light + dark) -->
+  <link rel="stylesheet" media="(prefers-color-scheme: light)" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
+  <link rel="stylesheet" media="(prefers-color-scheme: dark)" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">
+
+
+  <link rel="icon" href="media/nodedge_logo.png">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '',
+      repo: '',
+      coverpage: true,
+      loadNavbar: true
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
+</body>
+</html>
diff --git a/docs/keywords.txt b/docs/keywords.txt
@@ -0,0 +1,14 @@
+graphical-editor
+visual-scripting
+block-diagram
+automated-research
+physical-systems
+simulation
+engineering
+robotics
+python3
+qt6
+pyside6
+windows
+macos
+linux
diff --git a/docs/media/add_edge.gif b/docs/media/add_edge.gif
diff --git a/docs/media/add_node.gif b/docs/media/add_node.gif
diff --git a/docs/media/nodedge_interface.png b/docs/media/nodedge_interface.png
diff --git a/docs/media/nodedge_logo.ico b/docs/media/nodedge_logo.ico
diff --git a/docs/media/nodedge_logo.png b/docs/media/nodedge_logo.png
diff --git a/docs/media/pongy.jpg b/docs/media/pongy.jpg
diff --git a/docs/media/rename_nodes_02.gif b/docs/media/rename_nodes_02.gif
diff --git a/docs/media/zoom_in_out.gif b/docs/media/zoom_in_out.gif
diff --git a/docs/resources.md b/docs/resources.md
@@ -0,0 +1,33 @@
+# Documentation
+
+Nodedge’s user manual is available online and is automatically updated every time the API is updated.
+
+* [Nodedge user manual](https://nodedge.readthedocs.io/en/latest/)
+* [Github wiki](https://github.com/nodedge/nodedge/wiki)
+
+# Examples
+
+The list of examples is growing day by day.
+Find some [here](https://github.com/nodedge/nodedge/tree/master/examples).
+
+# Tutorials
+
+Here we offer a collection of free tutorials to get started with Nodedge and to explore the more advanced Nodedge features.
+This library is greatly under construction, we would appreciate your help in improving it!
+
+> Add a node
+
+![](media/add_node.gif) 
+
+> Add an edge
+
+![](media/add_edge.gif)
+
+> Rename a node
+
+![](media/rename_nodes_02.gif)  
+
+> Navigate the scene
+
+![](media/zoom_in_out.gif)
+
diff --git a/docs/Makefile → docs_sphinx/Makefile b/docs/Makefile → docs_sphinx/Makefile
diff --git a/docs/build_docs.py → docs_sphinx/build_docs.py b/docs/build_docs.py → docs_sphinx/build_docs.py
diff --git a/docs/make.bat → docs_sphinx/make.bat b/docs/make.bat → docs_sphinx/make.bat
diff --git a/docs/source/_templates/module.rst_t → docs_sphinx/source/_templates/module.rst_t b/docs/source/_templates/module.rst_t → docs_sphinx/source/_templates/module.rst_t
diff --git a/docs/source/_templates/package.rst_t → docs_sphinx/source/_templates/package.rst_t b/docs/source/_templates/package.rst_t → docs_sphinx/source/_templates/package.rst_t
diff --git a/docs/source/_templates/toc.rst_t → docs_sphinx/source/_templates/toc.rst_t b/docs/source/_templates/toc.rst_t → docs_sphinx/source/_templates/toc.rst_t
diff --git a/...rce/apidoc/nodedge.application_styler.rst → ...rce/apidoc/nodedge.application_styler.rst b/...rce/apidoc/nodedge.application_styler.rst → ...rce/apidoc/nodedge.application_styler.rst
diff --git a/...dge.blocks.autogen.operator.add_block.rst → ...dge.blocks.autogen.operator.add_block.rst b/...dge.blocks.autogen.operator.add_block.rst → ...dge.blocks.autogen.operator.add_block.rst
diff --git a/...edge.blocks.autogen.operator.eq_block.rst → ...edge.blocks.autogen.operator.eq_block.rst b/...edge.blocks.autogen.operator.eq_block.rst → ...edge.blocks.autogen.operator.eq_block.rst
diff --git a/...edge.blocks.autogen.operator.ge_block.rst → ...edge.blocks.autogen.operator.ge_block.rst b/...edge.blocks.autogen.operator.ge_block.rst → ...edge.blocks.autogen.operator.ge_block.rst
diff --git a/...edge.blocks.autogen.operator.gt_block.rst → ...edge.blocks.autogen.operator.gt_block.rst b/...edge.blocks.autogen.operator.gt_block.rst → ...edge.blocks.autogen.operator.gt_block.rst
diff --git a/...edge.blocks.autogen.operator.le_block.rst → ...edge.blocks.autogen.operator.le_block.rst b/...edge.blocks.autogen.operator.le_block.rst → ...edge.blocks.autogen.operator.le_block.rst
diff --git a/...edge.blocks.autogen.operator.lt_block.rst → ...edge.blocks.autogen.operator.lt_block.rst b/...edge.blocks.autogen.operator.lt_block.rst → ...edge.blocks.autogen.operator.lt_block.rst
diff --git a/...dge.blocks.autogen.operator.mod_block.rst → ...dge.blocks.autogen.operator.mod_block.rst b/...dge.blocks.autogen.operator.mod_block.rst → ...dge.blocks.autogen.operator.mod_block.rst
diff --git a/...dge.blocks.autogen.operator.mul_block.rst → ...dge.blocks.autogen.operator.mul_block.rst b/...dge.blocks.autogen.operator.mul_block.rst → ...dge.blocks.autogen.operator.mul_block.rst
diff --git a/...dge.blocks.autogen.operator.pow_block.rst → ...dge.blocks.autogen.operator.pow_block.rst b/...dge.blocks.autogen.operator.pow_block.rst → ...dge.blocks.autogen.operator.pow_block.rst
diff --git a/...pidoc/nodedge.blocks.autogen.operator.rst → ...pidoc/nodedge.blocks.autogen.operator.rst b/...pidoc/nodedge.blocks.autogen.operator.rst → ...pidoc/nodedge.blocks.autogen.operator.rst
diff --git a/...dge.blocks.autogen.operator.sub_block.rst → ...dge.blocks.autogen.operator.sub_block.rst b/...dge.blocks.autogen.operator.sub_block.rst → ...dge.blocks.autogen.operator.sub_block.rst
diff --git a/...blocks.autogen.operator.truediv_block.rst → ...blocks.autogen.operator.truediv_block.rst b/...blocks.autogen.operator.truediv_block.rst → ...blocks.autogen.operator.truediv_block.rst
diff --git a/.../source/apidoc/nodedge.blocks.autogen.rst → .../source/apidoc/nodedge.blocks.autogen.rst b/.../source/apidoc/nodedge.blocks.autogen.rst → .../source/apidoc/nodedge.blocks.autogen.rst
diff --git a/docs/source/apidoc/nodedge.blocks.block.rst → ...nx/source/apidoc/nodedge.blocks.block.rst b/docs/source/apidoc/nodedge.blocks.block.rst → ...nx/source/apidoc/nodedge.blocks.block.rst
diff --git a/...ce/apidoc/nodedge.blocks.block_config.rst → ...ce/apidoc/nodedge.blocks.block_config.rst b/...ce/apidoc/nodedge.blocks.block_config.rst → ...ce/apidoc/nodedge.blocks.block_config.rst
diff --git a/...apidoc/nodedge.blocks.block_exception.rst → ...apidoc/nodedge.blocks.block_exception.rst b/...apidoc/nodedge.blocks.block_exception.rst → ...apidoc/nodedge.blocks.block_exception.rst
diff --git a/...doc/nodedge.blocks.custom.input_block.rst → ...doc/nodedge.blocks.custom.input_block.rst b/...doc/nodedge.blocks.custom.input_block.rst → ...doc/nodedge.blocks.custom.input_block.rst
diff --git a/...oc/nodedge.blocks.custom.output_block.rst → ...oc/nodedge.blocks.custom.output_block.rst b/...oc/nodedge.blocks.custom.output_block.rst → ...oc/nodedge.blocks.custom.output_block.rst
diff --git a/docs/source/apidoc/nodedge.blocks.custom.rst → ...x/source/apidoc/nodedge.blocks.custom.rst b/docs/source/apidoc/nodedge.blocks.custom.rst → ...x/source/apidoc/nodedge.blocks.custom.rst
diff --git a/.../apidoc/nodedge.blocks.graphics_block.rst → .../apidoc/nodedge.blocks.graphics_block.rst b/.../apidoc/nodedge.blocks.graphics_block.rst → .../apidoc/nodedge.blocks.graphics_block.rst
diff --git a/...nodedge.blocks.graphics_block_content.rst → ...nodedge.blocks.graphics_block_content.rst b/...nodedge.blocks.graphics_block_content.rst → ...nodedge.blocks.graphics_block_content.rst
diff --git a/...e.blocks.graphics_input_block_content.rst → ...e.blocks.graphics_input_block_content.rst b/...e.blocks.graphics_input_block_content.rst → ...e.blocks.graphics_input_block_content.rst
diff --git a/....blocks.graphics_output_block_content.rst → ....blocks.graphics_output_block_content.rst b/....blocks.graphics_output_block_content.rst → ....blocks.graphics_output_block_content.rst
diff --git a/docs/source/apidoc/nodedge.blocks.rst → docs_sphinx/source/apidoc/nodedge.blocks.rst b/docs/source/apidoc/nodedge.blocks.rst → docs_sphinx/source/apidoc/nodedge.blocks.rst
diff --git a/docs/source/apidoc/nodedge.connector.rst → ...phinx/source/apidoc/nodedge.connector.rst b/docs/source/apidoc/nodedge.connector.rst → ...phinx/source/apidoc/nodedge.connector.rst
diff --git a/docs/source/apidoc/nodedge.edge.rst → docs_sphinx/source/apidoc/nodedge.edge.rst b/docs/source/apidoc/nodedge.edge.rst → docs_sphinx/source/apidoc/nodedge.edge.rst
diff --git a/docs/source/apidoc/nodedge.edge_dragging.rst → ...x/source/apidoc/nodedge.edge_dragging.rst b/docs/source/apidoc/nodedge.edge_dragging.rst → ...x/source/apidoc/nodedge.edge_dragging.rst
diff --git a/...source/apidoc/nodedge.edge_validators.rst → ...source/apidoc/nodedge.edge_validators.rst b/...source/apidoc/nodedge.edge_validators.rst → ...source/apidoc/nodedge.edge_validators.rst
diff --git a/docs/source/apidoc/nodedge.editor_widget.rst → ...x/source/apidoc/nodedge.editor_widget.rst b/docs/source/apidoc/nodedge.editor_widget.rst → ...x/source/apidoc/nodedge.editor_widget.rst
diff --git a/docs/source/apidoc/nodedge.editor_window.rst → ...x/source/apidoc/nodedge.editor_window.rst b/docs/source/apidoc/nodedge.editor_window.rst → ...x/source/apidoc/nodedge.editor_window.rst
diff --git a/...urce/apidoc/nodedge.graphics_cut_line.rst → ...urce/apidoc/nodedge.graphics_cut_line.rst b/...urce/apidoc/nodedge.graphics_cut_line.rst → ...urce/apidoc/nodedge.graphics_cut_line.rst
diff --git a/docs/source/apidoc/nodedge.graphics_edge.rst → ...x/source/apidoc/nodedge.graphics_edge.rst b/docs/source/apidoc/nodedge.graphics_edge.rst → ...x/source/apidoc/nodedge.graphics_edge.rst
diff --git a/docs/source/apidoc/nodedge.graphics_node.rst → ...x/source/apidoc/nodedge.graphics_node.rst b/docs/source/apidoc/nodedge.graphics_node.rst → ...x/source/apidoc/nodedge.graphics_node.rst
diff --git a/.../apidoc/nodedge.graphics_node_content.rst → .../apidoc/nodedge.graphics_node_content.rst b/.../apidoc/nodedge.graphics_node_content.rst → .../apidoc/nodedge.graphics_node_content.rst
diff --git a/...doc/nodedge.graphics_node_title_label.rst → ...doc/nodedge.graphics_node_title_label.rst b/...doc/nodedge.graphics_node_title_label.rst → ...doc/nodedge.graphics_node_title_label.rst
diff --git a/.../source/apidoc/nodedge.graphics_scene.rst → .../source/apidoc/nodedge.graphics_scene.rst b/.../source/apidoc/nodedge.graphics_scene.rst → .../source/apidoc/nodedge.graphics_scene.rst
diff --git a/...source/apidoc/nodedge.graphics_socket.rst → ...source/apidoc/nodedge.graphics_socket.rst b/...source/apidoc/nodedge.graphics_socket.rst → ...source/apidoc/nodedge.graphics_socket.rst
diff --git a/docs/source/apidoc/nodedge.graphics_view.rst → ...x/source/apidoc/nodedge.graphics_view.rst b/docs/source/apidoc/nodedge.graphics_view.rst → ...x/source/apidoc/nodedge.graphics_view.rst
diff --git a/...ce/apidoc/nodedge.history_list_widget.rst → ...ce/apidoc/nodedge.history_list_widget.rst b/...ce/apidoc/nodedge.history_list_widget.rst → ...ce/apidoc/nodedge.history_list_widget.rst
diff --git a/docs/source/apidoc/nodedge.logger.rst → docs_sphinx/source/apidoc/nodedge.logger.rst b/docs/source/apidoc/nodedge.logger.rst → docs_sphinx/source/apidoc/nodedge.logger.rst
diff --git a/docs/source/apidoc/nodedge.mdi_area.rst → ...sphinx/source/apidoc/nodedge.mdi_area.rst b/docs/source/apidoc/nodedge.mdi_area.rst → ...sphinx/source/apidoc/nodedge.mdi_area.rst
diff --git a/docs/source/apidoc/nodedge.mdi_widget.rst → ...hinx/source/apidoc/nodedge.mdi_widget.rst b/docs/source/apidoc/nodedge.mdi_widget.rst → ...hinx/source/apidoc/nodedge.mdi_widget.rst
diff --git a/docs/source/apidoc/nodedge.mdi_window.rst → ...hinx/source/apidoc/nodedge.mdi_window.rst b/docs/source/apidoc/nodedge.mdi_window.rst → ...hinx/source/apidoc/nodedge.mdi_window.rst
diff --git a/docs/source/apidoc/nodedge.node.rst → docs_sphinx/source/apidoc/nodedge.node.rst b/docs/source/apidoc/nodedge.node.rst → docs_sphinx/source/apidoc/nodedge.node.rst
diff --git a/...ource/apidoc/nodedge.node_tree_widget.rst → ...ource/apidoc/nodedge.node_tree_widget.rst b/...ource/apidoc/nodedge.node_tree_widget.rst → ...ource/apidoc/nodedge.node_tree_widget.rst
diff --git a/docs/source/apidoc/nodedge.rst → docs_sphinx/source/apidoc/nodedge.rst b/docs/source/apidoc/nodedge.rst → docs_sphinx/source/apidoc/nodedge.rst
diff --git a/docs/source/apidoc/nodedge.scene.rst → docs_sphinx/source/apidoc/nodedge.scene.rst b/docs/source/apidoc/nodedge.scene.rst → docs_sphinx/source/apidoc/nodedge.scene.rst
diff --git a/...source/apidoc/nodedge.scene_clipboard.rst → ...source/apidoc/nodedge.scene_clipboard.rst b/...source/apidoc/nodedge.scene_clipboard.rst → ...source/apidoc/nodedge.scene_clipboard.rst
diff --git a/docs/source/apidoc/nodedge.scene_coder.rst → ...inx/source/apidoc/nodedge.scene_coder.rst b/docs/source/apidoc/nodedge.scene_coder.rst → ...inx/source/apidoc/nodedge.scene_coder.rst
diff --git a/docs/source/apidoc/nodedge.scene_history.rst → ...x/source/apidoc/nodedge.scene_history.rst b/docs/source/apidoc/nodedge.scene_history.rst → ...x/source/apidoc/nodedge.scene_history.rst
diff --git a/...idoc/nodedge.scene_item_detail_widget.rst → ...idoc/nodedge.scene_item_detail_widget.rst b/...idoc/nodedge.scene_item_detail_widget.rst → ...idoc/nodedge.scene_item_detail_widget.rst
diff --git a/...idoc/nodedge.scene_items_table_widget.rst → ...idoc/nodedge.scene_items_table_widget.rst b/...idoc/nodedge.scene_items_table_widget.rst → ...idoc/nodedge.scene_items_table_widget.rst
diff --git a/docs/source/apidoc/nodedge.serializable.rst → ...nx/source/apidoc/nodedge.serializable.rst b/docs/source/apidoc/nodedge.serializable.rst → ...nx/source/apidoc/nodedge.serializable.rst
diff --git a/docs/source/apidoc/nodedge.socket_type.rst → ...inx/source/apidoc/nodedge.socket_type.rst b/docs/source/apidoc/nodedge.socket_type.rst → ...inx/source/apidoc/nodedge.socket_type.rst
diff --git a/docs/source/apidoc/nodedge.utils.rst → docs_sphinx/source/apidoc/nodedge.utils.rst b/docs/source/apidoc/nodedge.utils.rst → docs_sphinx/source/apidoc/nodedge.utils.rst
diff --git a/docs/source/conf.py → docs_sphinx/source/conf.py b/docs/source/conf.py → docs_sphinx/source/conf.py
diff --git a/docs/source/conventions.rst → docs_sphinx/source/conventions.rst b/docs/source/conventions.rst → docs_sphinx/source/conventions.rst
diff --git a/docs/source/evaluation.rst → docs_sphinx/source/evaluation.rst b/docs/source/evaluation.rst → docs_sphinx/source/evaluation.rst
diff --git a/docs/source/events.rst → docs_sphinx/source/events.rst b/docs/source/events.rst → docs_sphinx/source/events.rst
diff --git a/docs/source/events_scene.rst → docs_sphinx/source/events_scene.rst b/docs/source/events_scene.rst → docs_sphinx/source/events_scene.rst
diff --git a/docs/source/events_scene_history.rst → docs_sphinx/source/events_scene_history.rst b/docs/source/events_scene_history.rst → docs_sphinx/source/events_scene_history.rst
diff --git a/docs/source/examples.rst → docs_sphinx/source/examples.rst b/docs/source/examples.rst → docs_sphinx/source/examples.rst
diff --git a/docs/source/index.rst → docs_sphinx/source/index.rst b/docs/source/index.rst → docs_sphinx/source/index.rst
diff --git a/docs/source/intro.rst → docs_sphinx/source/intro.rst b/docs/source/intro.rst → docs_sphinx/source/intro.rst
diff --git a/docs/source/serialization.rst → docs_sphinx/source/serialization.rst b/docs/source/serialization.rst → docs_sphinx/source/serialization.rst
diff --git a/readthedocs.yml b/readthedocs.yml
@@ -5,18 +5,18 @@
 # Required
 version: 2
 
-# Build documentation in the docs/ directory with Sphinx
+# Build documentation in the docs_sphinx/ directory with Sphinx
 sphinx:
-  configuration: docs/source/conf.py
+  configuration: docs_sphinx/source/conf.py
 
 # Build documentation with MkDocs
 #mkdocs:
 #  configuration: mkdocs.yml
 
-# Optionally build your docs in additional formats such as PDF and ePub
+# Optionally build your docs_sphinx in additional formats such as PDF and ePub
 formats: all
 
-# Optionally set the version of Python and requirements required to build your docs
+# Optionally set the version of Python and requirements required to build your docs_sphinx
 python:
   version: 3.6
   install:

diff --git a/tox.ini b/tox.ini
@@ -1,6 +1,6 @@
 [tox]
-envlist = begin,py38,py39,py310,black, packaging,coverage,mypy,docs
-;envlist = {py38,py39,py310}-{linux,macos,windows}, {begin,black, packaging,coverage,mypy,docs}-{windows}
+envlist = begin,py38,py39,py310,black, packaging,coverage,mypy,docs_sphinx
+;envlist = {py38,py39,py310}-{linux,macos,windows}, {begin,black, packaging,coverage,mypy,docs_sphinx}-{windows}
 
 [default]
 basepython = python3.10
@@ -83,8 +83,8 @@ commands =
     coverage html
     codecov -e CODECOV_TOKEN
 
-[testenv:docs]
-changedir = docs
+[testenv:docs_sphinx]
+changedir = docs_sphinx
 deps = -rrequirements_docs.txt
 commands =
     sphinx-build -b html -d {envtmpdir}/doctrees ./source {envtmpdir}/html
@@ -94,7 +94,7 @@ python =
     3.7: py37
     3.8: py38
     3.9: py39
-    3.10: py310, mypy, flake8, black, coverage, packaging, docs
+    3.10: py310, mypy, flake8, black, coverage, packaging, docs_sphinx
 
 ;[gh-actions:env]
 ;PLATFORM =