Skip to content

Commit 430cd21

Browse files
authored
docs: add prototype of sphinx docs and design docs
1 parent 3073b3c commit 430cd21

21 files changed

+1043
-17
lines changed

docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/design.md

Lines changed: 545 additions & 0 deletions
Large diffs are not rendered by default.

docs/design.pdf

508 KB
Binary file not shown.

docs/make.bat

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

docs/source/_static/EM algo.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/source/_static/example_1.png

46.1 KB
Loading

docs/source/_static/example_2.png

43.4 KB
Loading

docs/source/_static/mixture.png

24.7 KB
Loading

docs/source/api/modules.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
mpest
2+
=====
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
mpest

docs/source/api/mpest.core.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
mpest.core
2+
==================
3+
4+
.. automodule:: mpest.core
5+
:members:
6+
:show-inheritance:
7+
:undoc-members:
8+
9+
Submodules
10+
----------
11+
12+
mpest.core.distribution module
13+
------------------------------
14+
15+
.. automodule:: mpest.core.distribution
16+
:members:
17+
:show-inheritance:
18+
:undoc-members:
19+
20+
mpest.core.mixture\_distribution module
21+
---------------------------------------
22+
23+
.. automodule:: mpest.core.mixture_distribution
24+
:members:
25+
:show-inheritance:
26+
:undoc-members:
27+
28+
mpest.core.problem module
29+
-------------------------
30+
31+
.. automodule:: mpest.core.problem
32+
:members:
33+
:show-inheritance:
34+
:undoc-members:

0 commit comments

Comments
 (0)