fortran-lang · jalvesz · Jun 30, 2024 · Jun 30, 2024 · Jul 1, 2024 · Jul 1, 2024
diff --git a/doc/Makefile b/doc/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = 
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/doc/conf.py b/doc/conf.py
@@ -0,0 +1,33 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+with open('../VERSION') as version_file:
+    version = version_file.read().strip()
+
+project = 'stdlib'
+copyright = '2024, stdlib contributors'
+author = 'stdlib contributors'
+release = version
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'myst_parser',            # enable markdown files for sphinx
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'pydata_sphinx_theme'
+html_static_path = ['_static']
diff --git a/doc/index.md b/doc/index.md
diff --git a/doc/index.rst b/doc/index.rst
@@ -0,0 +1,23 @@
+.. stdlib documentation master file, created by
+   sphinx-quickstart on Sat May 11 17:18:44 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   ../README
+   specs/index
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/doc/make.bat b/doc/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=%~dp0
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -0,0 +1,3 @@
+sphinx
+myst_parser
+pydata_sphinx_theme
diff --git a/doc/specs/index.md b/doc/specs/index.md
diff --git a/doc/specs/index.rst b/doc/specs/index.rst
@@ -0,0 +1,42 @@
+Fortran stdlib Specifications (specs)
+=====================================
+
+This is an index/directory of the specifications (specs) for each new module/feature as described in the
+[workflow document](../Workflow.html).
+
+Experimental Features & Modules
+===============================
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Contents:
+
+    stdlib_ansi
+    stdlib_array
+    stdlib_ascii
+    stdlib_bitsets
+    stdlib_constants
+    stdlib_error
+    stdlib_hash_prcedures
+    stdlib_hashmaps
+    stdlib_io
+    stdlib_kinds
+    stdlib_linalg
+    stdlib_linalg_state_type
+    stdlib_logger
+    stdlib_math
+    stdlib_optval
+    stdlib_quadrature
+    stdlib_random
+    stdlib_selection
+    stdlib_sorting
+    stdlib_specialfunctions_gamma
+    stdlib_specialfunctions
+    stdlib_stats_distribution_exponential
+    stdlib_stats_distribution_uniform
+    stdlib_stats
+    stdlib_str2num
+    stdlib_string_type
+    stdlib_stringlist_type
+    stdlib_strings 
+    stdlib_version
diff --git a/doc/specs/stdlib_ansi.md b/doc/specs/stdlib_ansi.md
@@ -1,12 +1,5 @@
----
-title: terminal colors
-...
-
-
-# The `stdlib_ansi` module
-
-[TOC]
-
+# `stdlib_ansi`
+
 ## Introduction
 
 Support terminal escape sequences to produce styled and colored terminal output.

diff --git a/doc/specs/stdlib_array.md b/doc/specs/stdlib_array.md
@@ -1,11 +1,5 @@
----
-title: array
----
-
-# The `stdlib_array` module
-
-[TOC]
-
+# `stdlib_array`
+
 ## Introduction
 
 Module for index manipulation and array handling tasks.
@@ -45,8 +39,8 @@ Returns an array of default integer size, with a maximum length of `size(array)`
 
 #### Examples
 
-```fortran
-{!example/array/example_trueloc.f90!}
+```{literalinclude} ../../example/array/example_trueloc.f90
+:language: Fortran
 ```
 
 
@@ -82,6 +76,6 @@ Returns an array of default integer size, with a maximum length of `size(array)`
 
 #### Examples
 
-```fortran
-{!example/array/example_falseloc.f90!}
-```
+```{literalinclude} ../../example/array/example_falseloc.f90
+:language: Fortran
+```
diff --git a/doc/specs/stdlib_ascii.md b/doc/specs/stdlib_ascii.md
@@ -1,11 +1,5 @@
----
-title: ascii
----
-
-# The `stdlib_ascii` module
-
-[TOC]
-
+# `stdlib_ascii`
+
 ## Introduction
 
 The `stdlib_ascii` module provides procedures for handling and manipulating
@@ -50,9 +44,9 @@ The result is an intrinsic character type of the same length as `string`.
 
 #### Example
 
-```fortran
-{!example/ascii/example_ascii_to_lower.f90!}
-``` 
+```{literalinclude} ../../example/ascii/example_ascii_to_lower.f90
+:language: Fortran
+```
 
 ### `to_upper`
 
@@ -82,8 +76,8 @@ The result is an intrinsic character type of the same length as `string`.
 
 #### Example
 
-```fortran
-{!example/ascii/example_ascii_to_upper.f90!}
+```{literalinclude} ../../example/ascii/example_ascii_to_upper.f90
+:language: Fortran
 ```
 
 ### `to_title`
@@ -119,8 +113,8 @@ The result is an intrinsic character type of the same length as `string`.
 
 #### Example
 
-```fortran
-{!example/ascii/example_ascii_to_title.f90!}
+```{literalinclude} ../../example/ascii/example_ascii_to_title.f90
+:language: Fortran
 ```
 
 ### `to_sentence`
@@ -154,8 +148,8 @@ The result is an intrinsic character type of the same length as `string`.
 
 #### Example
 
-```fortran
-{!example/ascii/example_ascii_to_sentence.f90!}
+```{literalinclude} ../../example/ascii/example_ascii_to_sentence.f90
+:language: Fortran
 ```
 
 ### `reverse`
@@ -186,6 +180,6 @@ The result is an intrinsic character type of the same length as `string`.
 
 #### Example
 
-```fortran
-{!example/ascii/example_ascii_reverse.f90!}
-```
+```{literalinclude} ../../example/ascii/example_ascii_reverse.f90
+:language: Fortran
+```