Commit ea10cf1c authored by Joel Collins's avatar Joel Collins
Browse files

Created initial general documentation

parent dd7a3ff2
Loading
Loading
Loading
Loading

doc/Makefile

0 → 100644
+19 −0
Original line number Diff line number Diff line
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
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)
 No newline at end of file

doc/make.bat

0 → 100644
+35 −0
Original line number Diff line number Diff line
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
	set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build

if "%1" == "" goto help

%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.http://sphinx-doc.org/
	exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd

doc/requirements.txt

0 → 100644
+3 −0
Original line number Diff line number Diff line
Sphinx
sphinxcontrib-httpdomain
sphinx_rtd_theme
 No newline at end of file

doc/source/api.rst

0 → 100644
+24 −0
Original line number Diff line number Diff line
REST API
======================================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

API Documentation
=================

Summary
-------
.. qrefflask:: openflexure_microscope.api.v1:app
   :undoc-endpoints: index
   :undoc-static:
   :endpoints:

Details
-----------
.. autoflask:: openflexure_microscope.api.v1:app
   :undoc-endpoints: index
   :undoc-static:
   :endpoints:
   :order: path
 No newline at end of file
+5 −0
Original line number Diff line number Diff line
Base Streaming Camera
=======================================================

.. automodule:: openflexure_microscope.camera.base
    :members:
 No newline at end of file
Loading