diff --git a/_static/css/modified-theme.css b/_static/css/modified-theme.css
deleted file mode 100644
index de54b451..00000000
--- a/_static/css/modified-theme.css
+++ /dev/null
@@ -1,35 +0,0 @@
-@import 'theme.css'; /* for the Read the Docs theme */
-
-body, input, textarea {
- font-family: Open Sans, sans-serif;
- font-size: 1rem;
- font-weight: 200;
- line-height: 1.6;
-}
-
-.rst-content .toctree-wrapper > p.caption, h1, h2, h3, h4, h5, h6, legend {
- font-family: Open Sans, sans-serif;
- font-size: 2rem;
- letter-spacing: 0.17rem;
- font-weight: 300;
- line-height: 1.4;
- margin: 2.75rem 0px 1.05rem;
- text-transform: none;
-}
-
-.wy-nav-content {
- max-width: none;
-}
-
-@media screen and (min-width: 767px) {
-
- .wy-table-responsive table td {
- /* !important prevents the common CSS stylesheets from overriding
- this as on RTD they are loaded after this stylesheet */
- white-space: normal !important;
- }
-
- .wy-table-responsive {
- overflow: visible !important;
- }
- }
\ No newline at end of file
diff --git a/_templates/layout.html b/_templates/layout.html
deleted file mode 100644
index 661a1d96..00000000
--- a/_templates/layout.html
+++ /dev/null
@@ -1,7 +0,0 @@
-{% extends "!layout.html" %}
-
-{% block footer %}
-{{ super() }}
-
-{% endblock %}
\ No newline at end of file
diff --git a/contribute-cardano/ambassadors-program.md b/cardano-community/ambassadors-program.md
similarity index 100%
rename from contribute-cardano/ambassadors-program.md
rename to cardano-community/ambassadors-program.md
diff --git a/contribute-cardano/community-generated-content.md b/cardano-community/community-generated-content.md
similarity index 100%
rename from contribute-cardano/community-generated-content.md
rename to cardano-community/community-generated-content.md
diff --git a/get-support.md b/cardano-community/get-support.md
similarity index 100%
rename from get-support.md
rename to cardano-community/get-support.md
diff --git a/contribute-cardano/index.rst b/cardano-community/index.rst
similarity index 100%
rename from contribute-cardano/index.rst
rename to cardano-community/index.rst
diff --git a/contribute-cardano/providing-feedback.md b/cardano-community/providing-feedback.md
similarity index 100%
rename from contribute-cardano/providing-feedback.md
rename to cardano-community/providing-feedback.md
diff --git a/cardano-logo.png b/cardano-logo.png
deleted file mode 100644
index 7233b4fb..00000000
Binary files a/cardano-logo.png and /dev/null differ
diff --git a/conf.py b/conf.py
index 02892287..8fcac370 100644
--- a/conf.py
+++ b/conf.py
@@ -1,21 +1,23 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-# -- Path setup --------------------------------------------------------------
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import sys
+import os
import sphinx_rtd_theme
import recommonmark
+
from recommonmark.transform import AutoStructify
+from os.path import abspath, join, dirname
+
+sys.path.insert(0, abspath(join(dirname(__file__))))
+
+# -- RTD configuration ------------------------------------------------
+
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
+
+# This is used for linking and such so we link to the thing we're building
+rtd_version = os.environ.get("READTHEDOCS_VERSION", "latest")
+if rtd_version not in ["stable", "latest"]:
+ rtd_version = "stable"
# -- Project information -----------------------------------------------------
@@ -35,21 +37,32 @@
extensions = [
"sphinx_rtd_theme",
- 'sphinxcontrib.mermaid',
'recommonmark',
'sphinx_markdown_tables',
- 'sphinxemoji.sphinxemoji'
+ 'sphinxemoji.sphinxemoji',
+ "sphinx.ext.autodoc",
+ "sphinx.ext.autosummary",
+ "sphinx.ext.intersphinx",
+ "sphinx.ext.viewcode",
]
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-html_static_path = ['_static']
+templates_path = ['.sphinx/_templates']
+html_static_path = ['.sphinx/_static']
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
}
+intersphinx_mapping = {
+ "cardano-node": (
+ "https://cardano.readthedocs.io/projects/cardano-node/en/%s/"
+ % rtd_version,
+ None,
+ ),
+}
+
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
@@ -65,8 +78,8 @@
html_style = 'css/modified-theme.css'
html_theme_options = {
- 'logo_only': True,
- 'display_version': True,
+ 'logo_only': False,
+ 'display_version': False,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
'vcs_pageview_mode': '',
@@ -83,7 +96,7 @@
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_logo = "cardano-logo.png"
+html_logo = ".sphinx/cardano-logo.png"
html_context = {
"display_github": True, # Add 'Edit on Github' link instead of 'View page source'
@@ -94,6 +107,8 @@
"source_suffix": source_suffix,
}
+# -- Custom Document processing ----------------------------------------------
+
def setup(app):
app.add_config_value('recommonmark_config', {
'enable_auto_doc_ref': False,
diff --git a/learn-about-cardano/further-reading.md b/explore-cardano/further-reading.md
similarity index 100%
rename from learn-about-cardano/further-reading.md
rename to explore-cardano/further-reading.md
diff --git a/glossary.rst b/explore-cardano/glossary.rst
similarity index 100%
rename from glossary.rst
rename to explore-cardano/glossary.rst
diff --git a/learn-about-cardano/index.rst b/explore-cardano/index.rst
similarity index 100%
rename from learn-about-cardano/index.rst
rename to explore-cardano/index.rst
diff --git a/learn-about-cardano/pledge_formula.png b/explore-cardano/pledge_formula.png
similarity index 100%
rename from learn-about-cardano/pledge_formula.png
rename to explore-cardano/pledge_formula.png
diff --git a/learn-about-cardano/proof-of-stake.md b/explore-cardano/proof-of-stake.md
similarity index 100%
rename from learn-about-cardano/proof-of-stake.md
rename to explore-cardano/proof-of-stake.md
diff --git a/release-notes.md b/explore-cardano/release-notes.md
similarity index 100%
rename from release-notes.md
rename to explore-cardano/release-notes.md
diff --git a/learn-about-cardano/understanding-consensus.md b/explore-cardano/understanding-consensus.md
similarity index 100%
rename from learn-about-cardano/understanding-consensus.md
rename to explore-cardano/understanding-consensus.md
diff --git a/learn-about-cardano/understanding-pledging-and-rewards.md b/explore-cardano/understanding-pledging-and-rewards.md
similarity index 100%
rename from learn-about-cardano/understanding-pledging-and-rewards.md
rename to explore-cardano/understanding-pledging-and-rewards.md
diff --git a/learn-about-cardano/understanding-the-delegation-mechanism.md b/explore-cardano/understanding-the-delegation-mechanism.md
similarity index 100%
rename from learn-about-cardano/understanding-the-delegation-mechanism.md
rename to explore-cardano/understanding-the-delegation-mechanism.md
diff --git a/learn-about-cardano/what-is-a-cardano-node.md b/explore-cardano/what-is-a-cardano-node.md
similarity index 100%
rename from learn-about-cardano/what-is-a-cardano-node.md
rename to explore-cardano/what-is-a-cardano-node.md
diff --git a/learn-about-cardano/what-is-a-stakepool.md b/explore-cardano/what-is-a-stakepool.md
similarity index 100%
rename from learn-about-cardano/what-is-a-stakepool.md
rename to explore-cardano/what-is-a-stakepool.md
diff --git a/getting-started/cardano-node-quickstart.md b/getting-started/cardano-node-quickstart.md
new file mode 100644
index 00000000..7227a4be
--- /dev/null
+++ b/getting-started/cardano-node-quickstart.md
@@ -0,0 +1,9 @@
+Getting Started with Cardano Node
+=================================
+
+For a user-friendly experience you can download wallets for Cardano, such as [Daedalus](https://daedaluswallet.io) or [Yoroi](https://yoroi-wallet.com)
+
+* [Building cardano-node using Nix](https://cardano.readthedocs.io/projects/cardano-node/en/latest/doc/building-the-node-using-nix.html)
+* [Building cardano-node from source](https://cardano.readthedocs.io/projects/cardano-node/en/latest/doc/building-the-node-from-source.html)
+* [Configuring cardano-node](https://cardano.readthedocs.io/projects/cardano-node/en/latest/doc/configuring-a-node-using-yaml.html)
+* [cardano-node CLI Reference](https://cardano.readthedocs.io/projects/cardano-node/en/latest/doc/cardano-node-cli-reference.html)
diff --git a/index.rst b/index.rst
index e8a48caf..0626b752 100644
--- a/index.rst
+++ b/index.rst
@@ -19,7 +19,7 @@ Cardano is developing a smart contract platform which seeks to deliver more adva
:titlesonly:
:hidden:
- cardano-node Quickstart
+ cardano-node Quickstart
Stake Pool Operators
3rd-party Integration
@@ -29,26 +29,32 @@ Cardano is developing a smart contract platform which seeks to deliver more adva
:titlesonly:
:hidden:
- learn-about-cardano/index
- cardano-tutorials/README
- glossary
- release-notes
+ explore-cardano/what-is-a-cardano-node
+ explore-cardano/understanding-consensus
+ explore-cardano/what-is-a-stakepool
+ explore-cardano/understanding-the-delegation-mechanism
+ explore-cardano/understanding-pledging-and-rewards
+ explore-cardano/further-reading
+ explore-cardano/glossary
+ explore-cardano/release-notes
.. toctree::
:maxdepth: 3
- :caption: Cardano Components
+ :caption: Cardano Community
:titlesonly:
:hidden:
- cardano-node 2
+ cardano-community/providing-feedback
+ cardano-community/ambassadors-program
+ cardano-community/community-generated-content
+ cardano-community/get-support
.. toctree::
- :maxdepth: 3
- :caption: Cardano Community
+ :caption: Cardano Components
:titlesonly:
:hidden:
- contribute-cardano/providing-feedback
- contribute-cardano/ambassadors-program
- contribute-cardano/community-generated-content
- get-support
+ cardano-node
+ cardano-adrestia
+ cardano-wallet
+ plutus
diff --git a/requirements/requirements.txt b/requirements/requirements.txt
deleted file mode 100644
index 271738b0..00000000
--- a/requirements/requirements.txt
+++ /dev/null
@@ -1,31 +0,0 @@
-Sphinx==3.1.1
-sphinx-intl==2.0.1
-transifex-client==0.13.10
-testresources==2.0.1
--e git+https://github.com/input-output-hk/sphinx_rtd_theme.git#egg=sphinx_rtd_theme
-recommonmark==0.6
-## The following requirements were added by pip freeze:
-alabaster==0.7.12
-Babel==2.8.0
-certifi==2020.4.5.2
-chardet==3.0.4
-click==7.1.2
-sphinxcontrib-mermaid==0.4.0
-sphinxemoji==0.1.6
-sphinx_markdown_tables==0.0.15
-CommonMark==0.9.1
-docutils==0.16
-future==0.18.2
-idna==2.9
-imagesize==1.2.0
-Jinja2==2.11.2
-jsonpointer==2.0
-jsonref==0.2
-MarkupSafe==1.1.1
-Pygments==2.6.1
-pytz==2020.1
-requests==2.24.0
-six==1.15.0
-snowballstemmer==2.0.0
-sphinxcontrib-websupport==1.2.2
-urllib3==1.25.9