fix

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,

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)

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-components/cardano-node/doc/cardano-node-quickstart>
+   cardano-node Quickstart <getting-started/cardano-node-quickstart>
    Stake Pool Operators <getting-started/stake-pool-operators/index>
    3rd-party Integration <getting-started/3rd-party-integration/index>
 
@@ -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 <https://cardano.readthedocs.io/projects/cardano-node/en/latest/>
+   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 <https://cardano.readthedocs.io/projects/cardano-node/en/latest/>
+   cardano-adrestia <https://cardano.readthedocs.io/projects/adrestia/en/latest/>
+   cardano-wallet <https://cardano.readthedocs.io/projects/cardano-wallet/en/latest/>
+   plutus <https://cardano.readthedocs.io/projects/plutus/en/latest/>