Skip to content
Snippets Groups Projects
Commit 28baca76 authored by Christoph Knote's avatar Christoph Knote
Browse files

Docs like that

parent aa9a6677
No related branches found
No related tags found
1 merge request!16Introduce poetry packaging
......@@ -30,8 +30,7 @@ create_docs:
script:
- poetry install
- cd docs
- poetry run sphinx-build -b html . build
- mv build/html/ ../public/
- poetry run sphinx-build -b html . ../public
artifacts:
paths:
- public
# 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)
... to make git keep a possibly empty directory ...
\ No newline at end of file
......@@ -51,4 +51,4 @@ html_theme = 'classic'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
\ No newline at end of file
html_static_path = []
\ No newline at end of file
File moved
File moved
@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% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
......@@ -4,14 +4,14 @@ Reading an existing dataset
Simple format (FFI 1001)
*************************
.. literalinclude:: ../../tests/usage_examples/read_ffi1001.py
.. literalinclude:: ../tests/usage_examples/read_ffi1001.py
More complex (FFI 2110)
*************************
Identical to FFI1001, only the data structure is more complex:
.. literalinclude:: ../../tests/usage_examples/read_ffi2110.py
.. literalinclude:: ../tests/usage_examples/read_ffi2110.py
Creating a new dataset
############################
......@@ -19,11 +19,11 @@ Creating a new dataset
Simple format (FFI 1001)
*************************
.. literalinclude:: ../../tests/usage_examples/create_ffi1001.py
.. literalinclude:: ../tests/usage_examples/create_ffi1001.py
More complex (FFI 2110)
*************************
Again, like for FFI 1001 but more complex data structure
.. literalinclude:: ../../tests/usage_examples/create_ffi2110.py
.. literalinclude:: ../tests/usage_examples/create_ffi2110.py
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment