Skip to content

Commit

Permalink
Add Sphinx skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
tmadden committed Jan 7, 2021
1 parent d72be2b commit 788b055
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 1 deletion.
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -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)
11 changes: 11 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import sphinx_rtd_theme

project = 'alia'
copyright = '2021, .decimal, LLC & Mass General Brigham'
author = 'Thomas Madden'

extensions = ['breathe', 'sphinx_rtd_theme']

exclude_patterns = ['_build']

html_theme = 'sphinx_rtd_theme'
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Welcome to alia's documentation!
================================

This is the reference documentation for alia...

.. toctree::
:maxdepth: 2
:caption: Contents
35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
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% %O%
goto end

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

:end
popd
2 changes: 1 addition & 1 deletion scripts/set-up-python.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ set -x -e
virtualenv --prompt="(alia) " "$@" .venv
source .venv/bin/activate
python --version
pip install gcovr
pip install gcovr sphinx==3.3.1 breathe

0 comments on commit 788b055

Please sign in to comment.