diff --git a/docs/source/_static/AYON_tight_G.svg b/docs/source/_static/AYON_tight_G.svg
new file mode 100644
index 0000000000..2c5b73deea
--- /dev/null
+++ b/docs/source/_static/AYON_tight_G.svg
@@ -0,0 +1,38 @@
+
+
+
diff --git a/docs/source/conf.py b/docs/source/conf.py
index b4fe161c2b..4d20fbb3d1 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -63,7 +63,6 @@ extensions = [
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
- 'sphinx.ext.viewcode',
'sphinx.ext.autosummary',
'revitron_sphinx_theme',
'autoapi.extension',
@@ -100,7 +99,7 @@ autoapi_template_dir = '_templates/autoapi'
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['templates']
+templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
@@ -149,10 +148,15 @@ html_theme = 'revitron_sphinx_theme'
# documentation.
#
html_theme_options = {
- 'collapse_navigation': False,
- 'navigation_depth': 5,
- 'titles_only': False
+ 'collapse_navigation': True,
+ 'sticky_navigation': True,
+ 'navigation_depth': 4,
+ 'includehidden': True,
+ 'titles_only': False,
+ 'github_url': '',
}
+html_logo = '_static/AYON_tight_G.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,
diff --git a/docs/source/index.rst b/docs/source/index.rst
index b1ce5f2331..f703468fca 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -4,11 +4,12 @@
contain the root `toctree` directive.
Welcome to OpenPype's API documentation!
-================================
+========================================
.. toctree::
- readme
- openpype
+
+ Readme
+
Indices and tables
==================
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
deleted file mode 100644
index a232a7c901..0000000000
--- a/docs/source/modules.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-igniter
-=======
-
-.. toctree::
- :maxdepth: 6
-
- igniter
- openpype
diff --git a/docs/source/readme.rst b/docs/source/readme.rst
index 842932f494..138b88bba8 100644
--- a/docs/source/readme.rst
+++ b/docs/source/readme.rst
@@ -1,2 +1,6 @@
-.. title:: OpenPype Readme
+===============
+OpenPype Readme
+===============
+
.. include:: ../../README.md
+ :parser: myst_parser.sphinx_
diff --git a/poetry.lock b/poetry.lock
index 4107ea8335..d7bdc5f7c4 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -1487,6 +1487,27 @@ files = [
{file = "lief-0.12.3.zip", hash = "sha256:62e81d2f1a827d43152aed12446a604627e8833493a51dca027026eed0ce7128"},
]
+[[package]]
+name = "linkify-it-py"
+version = "2.0.0"
+description = "Links recognition library with FULL unicode support."
+category = "main"
+optional = false
+python-versions = ">=3.6"
+files = [
+ {file = "linkify-it-py-2.0.0.tar.gz", hash = "sha256:476464480906bed8b2fa3813bf55566282e55214ad7e41b7d1c2b564666caf2f"},
+ {file = "linkify_it_py-2.0.0-py3-none-any.whl", hash = "sha256:1bff43823e24e507a099e328fc54696124423dd6320c75a9da45b4b754b748ad"},
+]
+
+[package.dependencies]
+uc-micro-py = "*"
+
+[package.extras]
+benchmark = ["pytest", "pytest-benchmark"]
+dev = ["black", "flake8", "isort", "pre-commit"]
+doc = ["myst-parser", "sphinx", "sphinx-book-theme"]
+test = ["coverage", "pytest", "pytest-cov"]
+
[[package]]
name = "log4mongo"
version = "1.7.0"
@@ -2250,20 +2271,21 @@ files = [
[[package]]
name = "pydocstyle"
-version = "3.0.0"
+version = "6.3.0"
description = "Python docstring style checker"
-category = "dev"
+category = "main"
optional = false
-python-versions = "*"
+python-versions = ">=3.6"
files = [
- {file = "pydocstyle-3.0.0-py2-none-any.whl", hash = "sha256:2258f9b0df68b97bf3a6c29003edc5238ff8879f1efb6f1999988d934e432bd8"},
- {file = "pydocstyle-3.0.0-py3-none-any.whl", hash = "sha256:ed79d4ec5e92655eccc21eb0c6cf512e69512b4a97d215ace46d17e4990f2039"},
- {file = "pydocstyle-3.0.0.tar.gz", hash = "sha256:5741c85e408f9e0ddf873611085e819b809fca90b619f5fd7f34bd4959da3dd4"},
+ {file = "pydocstyle-6.3.0-py3-none-any.whl", hash = "sha256:118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019"},
+ {file = "pydocstyle-6.3.0.tar.gz", hash = "sha256:7ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1"},
]
[package.dependencies]
-six = "*"
-snowballstemmer = "*"
+snowballstemmer = ">=2.2.0"
+
+[package.extras]
+toml = ["tomli (>=1.2.3)"]
[[package]]
name = "pyflakes"
@@ -3332,6 +3354,21 @@ files = [
{file = "typing_extensions-4.4.0.tar.gz", hash = "sha256:1511434bb92bf8dd198c12b1cc812e800d4181cfcb867674e0f8279cc93087aa"},
]
+[[package]]
+name = "uc-micro-py"
+version = "1.0.1"
+description = "Micro subset of unicode data files for linkify-it-py projects."
+category = "main"
+optional = false
+python-versions = ">=3.6"
+files = [
+ {file = "uc-micro-py-1.0.1.tar.gz", hash = "sha256:b7cdf4ea79433043ddfe2c82210208f26f7962c0cfbe3bacb05ee879a7fdb596"},
+ {file = "uc_micro_py-1.0.1-py3-none-any.whl", hash = "sha256:316cfb8b6862a0f1d03540f0ae6e7b033ff1fa0ddbe60c12cbe0d4cec846a69f"},
+]
+
+[package.extras]
+test = ["coverage", "pytest", "pytest-cov"]
+
[[package]]
name = "unidecode"
version = "1.3.6"
@@ -3641,4 +3678,4 @@ docs = []
[metadata]
lock-version = "2.0"
python-versions = ">=3.9.1,<3.10"
-content-hash = "2ec929512a99e5e7a16f46bc255171beabc41bba84e448e5312d7cd508a80de7"
+content-hash = "47518c544a90cdb3e99e83533557515d0d47079ac4461708ce71ab3ce97b9987"
diff --git a/pyproject.toml b/pyproject.toml
index cf86fb3b9f..b2b0e4c071 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -71,7 +71,6 @@ pysftp = "^0.2.9"
dropbox = "^11.20.0"
aiohttp-middlewares = "^2.0.0"
opencolorio = "^2.2.0"
-myst-parser = "^0.18.1"
[tool.poetry.dev-dependencies]
flake8 = "^6.0"
@@ -82,8 +81,10 @@ GitPython = "^3.1.17"
jedi = "^0.13"
Jinja2 = "^3"
markupsafe = "2.0.1"
-pycodestyle = "^2.5.0"
-pydocstyle = "^3.0.0"
+pycodestyle = "*"
+pydocstyle = "*"
+linkify-it-py = "^2.0.0"
+myst-parser = "^0.18.1"
pylint = "^2.4.4"
pytest = "^6.1"
pytest-cov = "*"