Incorporate Markdown documents into RST.

bigladder · Mar 29, 2024 · c05b9b4 · c05b9b4
1 parent c6f8dd7
commit c05b9b4
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 22 deletions.
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -6,7 +6,7 @@ set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 set(WARN_ON_DOC_ERROR "YES")
 set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/include/${PROJECT_NAME})
 set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen)
-#set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/html/index.html)
+set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/html/index.html)
 file(GLOB_RECURSE project_public_headers ${DOXYGEN_INPUT_DIR}/*.h)
 
 # Replace variables inside @@ with the current values

diff --git a/docs/sphinx-source/conf.py b/docs/sphinx-source/conf.py
@@ -9,19 +9,20 @@
 # pylint: disable=C0103
 
 project = 'atheneum'
-copyright = '2023, Big Ladder Software' # pylint: disable=redefined-builtin
+copyright = '2024, Big Ladder Software' # pylint: disable=redefined-builtin
 author = 'Big Ladder Software'
-release = '2023'
+release = '2024'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["breathe"]
+extensions = ["breathe",
+              "myst_parser",
+              ]
 
 templates_path = ['_templates']
 exclude_patterns = []
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
@@ -40,7 +41,7 @@
     'includehidden': True,
     'titles_only': False
 }
-#html_static_path = ['_static']
+#html_static_path = ['_static'] # Uncomment to add static content (e.g. CSS)
 breathe_default_project = project
 breathe_default_members = ('members', 'undoc-members')
 # set up breathe_projects here, or using -D on sphinx-build command line

diff --git a/docs/sphinx-source/docs.rst b/docs/sphinx-source/docs.rst
@@ -0,0 +1,10 @@
+API Documentation
+=================
+
+.. doxygenclass:: Atheneum::Atheneum
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
diff --git a/docs/sphinx-source/guidelines.rst b/docs/sphinx-source/guidelines.rst
@@ -0,0 +1,5 @@
+Guidelines
+==========
+
+.. include:: ../../doc/guidelines.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/sphinx-source/index.rst b/docs/sphinx-source/index.rst
@@ -1,7 +1,4 @@
-.. atheneum documentation master file, created by
-   sphinx-quickstart on Mon Jun 19 16:34:25 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. atheneum documentation master file should at least contain the root `toctree` directive.
 
 Welcome to atheneum documentation!
 =============================================
@@ -11,17 +8,8 @@ the industry's standard dummy text ever since the 1500s, when an unknown printer
 type and scrambled it to make a type specimen book. From `<https://www.lipsum.com/>`_
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Contents:
 
-Docs
-====
-
-.. doxygenclass:: Atheneum::Atheneum
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   guidelines
+   docs
diff --git a/pyproject.toml b/pyproject.toml
@@ -10,6 +10,7 @@ python = ">=3.9"
 [tool.poetry.dev-dependencies]
 sphinx = "7.2.6"
 breathe = "*"
+myst-parser = "*"
 sphinx-rtd-theme = "*"
 
 [build-system]