Merge pull request #35 from jessegrabowski/docs

Add sphinx docs

.github/workflows/rtd-link-preview.yml

@@ -0,0 +1,16 @@
+name: Read the Docs Pull Request Preview
+on:
+  pull_request_target:
+    types:
+      - opened
+
+permissions:
+  pull-requests: write
+
+jobs:
+  documentation-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "gEconpy"

.github/workflows/run_tests.yml

@@ -11,7 +11,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: ["3.9"]
+        python-version: ["3.12"]
         test-subset:
           - |
             tests/
@@ -55,7 +55,7 @@ jobs:
         activate-environment: geconpy-test
         channel-priority: strict
         environment-file: conda_envs/geconpy_test.yml
-        python-version: 3.9
+        python-version: 3.12
         use-mamba: true
         use-only-tar-bz2: false # IMPORTANT: This may break caching of conda packages! See https://github.com/conda-incubator/setup-miniconda/issues/267
 

.jupytext.toml

@@ -0,0 +1,2 @@
+notebook_metadata_filter = "myst,-jupytext.text_representation.jupytext_version"
+formats = ["ipynb", ".myst.md:myst"]

.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 1
+
+sphinx:
+    configuration: docs/source/conf.py
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+python:
+   install:
+   - requirements: requirements-docs.txt

docs/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     = source
+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)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+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

docs/source/about.rst

@@ -0,0 +1,4 @@
+About gEconpy
+=============
+
+WRITEME

docs/source/api.rst

@@ -0,0 +1,9 @@
+.. _api:
+
+API
+===
+
+.. toctree::
+    :maxdepth: 1
+
+    api/base

docs/source/api/base.rst

@@ -0,0 +1,9 @@
+DSGE Modeling
+*************
+
+.. automodule:: gEconpy.classes
+
+.. toctree::
+    :maxdepth: 1
+
+    base/classes

docs/source/api/base/classes.rst

@@ -0,0 +1,20 @@
+DSGE Model
+----------
+
+.. currentmodule:: gEconpy.classes.model
+
+.. autosummary::
+    :toctree: generated/
+
+    gEconModel
+
+
+Model Components
+----------------
+
+.. currentmodule:: gEconpy.classes.block
+
+.. autosummary::
+    :toctree: generated/
+
+    Block

docs/source/api/base/generated/classmethods/gEconpy.classes.block.Block.__init__.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.block.Block.\_\_init\_\_
+========================================
+
+.. currentmodule:: gEconpy.classes.block
+
+.. automethod:: Block.__init__

docs/source/api/base/generated/classmethods/gEconpy.classes.block.Block.initialize_from_dictionary.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.block.Block.initialize\_from\_dictionary
+========================================================
+
+.. currentmodule:: gEconpy.classes.block
+
+.. automethod:: Block.initialize_from_dictionary

docs/source/api/base/generated/classmethods/gEconpy.classes.block.Block.simplify_system_equations.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.block.Block.simplify\_system\_equations
+=======================================================
+
+.. currentmodule:: gEconpy.classes.block
+
+.. automethod:: Block.simplify_system_equations

docs/source/api/base/generated/classmethods/gEconpy.classes.block.Block.solve_optimization.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.block.Block.solve\_optimization
+===============================================
+
+.. currentmodule:: gEconpy.classes.block
+
+.. automethod:: Block.solve_optimization

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.__init__.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.\_\_init\_\_
+=============================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.__init__

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.build.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.build
+======================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.build

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.build_report.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.build\_report
+==============================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.build_report

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.check_bk_condition.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.check\_bk\_condition
+=====================================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.check_bk_condition

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.compute_autocorrelation_matrix.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.compute\_autocorrelation\_matrix
+=================================================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.compute_autocorrelation_matrix

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.compute_stationary_covariance_matrix.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.compute\_stationary\_covariance\_matrix
+========================================================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.compute_stationary_covariance_matrix

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.fit.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.fit
+====================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.fit

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.impulse_response_function.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.impulse\_response\_function
+============================================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.impulse_response_function

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.print_steady_state.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.print\_steady\_state
+=====================================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.print_steady_state

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.sample_param_dict_from_prior.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.sample\_param\_dict\_from\_prior
+=================================================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.sample_param_dict_from_prior

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.simulate.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.simulate
+=========================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.simulate

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.solve_model.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.solve\_model
+=============================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.solve_model

docs/source/api/base/generated/classmethods/gEconpy.classes.model.gEconModel.steady_state.rst

@@ -0,0 +1,6 @@
+gEconpy.classes.model.gEconModel.steady\_state
+==============================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. automethod:: gEconModel.steady_state

docs/source/api/base/generated/gEconpy.classes.block.Block.rst

@@ -0,0 +1,20 @@
+gEconpy.classes.block.Block
+===========================
+
+.. currentmodule:: gEconpy.classes.block
+
+.. autoclass:: Block
+
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: classmethods
+
+
+      Block.__init__
+      Block.initialize_from_dictionary
+      Block.simplify_system_equations
+      Block.solve_optimization

docs/source/api/base/generated/gEconpy.classes.model.gEconModel.rst

@@ -0,0 +1,29 @@
+gEconpy.classes.model.gEconModel
+================================
+
+.. currentmodule:: gEconpy.classes.model
+
+.. autoclass:: gEconModel
+
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: classmethods
+
+
+      gEconModel.__init__
+      gEconModel.build
+      gEconModel.build_report
+      gEconModel.check_bk_condition
+      gEconModel.compute_autocorrelation_matrix
+      gEconModel.compute_stationary_covariance_matrix
+      gEconModel.fit
+      gEconModel.impulse_response_function
+      gEconModel.print_steady_state
+      gEconModel.sample_param_dict_from_prior
+      gEconModel.simulate
+      gEconModel.solve_model
+      gEconModel.steady_state