Commit 983e74c8 authored by Jiahang Chen's avatar Jiahang Chen
Browse files

fix make html problem

parent 6386d34f
Pipeline #359674 failed with stage
in 31 seconds
# 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)
@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
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}
# -- Project information -----------------------------------------------------
project = 'Python Reference Implementation of fml40'
copyright = '2020, KWH40'
author = 'KWH40'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc']
# Add any paths that contain templates here, relative to this directory.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'recommonmark']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# 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
.. Python Reference Implementation of fml40 documentation master file, created by
sphinx-quickstart on Thu Nov 12 13:09:49 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Python Reference Implementation of fml40's documentation!
====================================================================
This a documentation for the Python Reference Implementation of fml40 library by Kompetenzzentrum Wald und Holz 4.0 (KWH4.0).
The documentation is composed of some preliminaries for installation, a quick start and the reference implementation package.
Table of Contents
-----------------
.. toctree::
:maxdepth: 2
:caption: Contents:
md/preliminaries.md
python_ref
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
# Preliminaries
## Requirements
* Python 3+
* recommended: virtualenv and optionally, but also recommended virtualenvwrapper
To install virtualenv and virtualenvwrapper, just execute (after installing Python):
```
pip install virtualenv
pip install virtualenvwrapper-win
```
More Information on how to use virtualenv can be found here: [The Hitchhiker's Guide to Python](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
## Preliminaries
We recommend creating a virtual environment for the project (`mkvirtualenv projectname`). After creating the environment, activate it (`workon projectname`). Navigate to the root folder containing the `requirements.txt` and install the required modules for the demo with (`pip install -r requirements.txt`).
Python Reference Implementation of fml40
=========================================
.. toctree::
:maxdepth: 2
:titlesonly:
:caption: Contents:
.. automodule:: ml.dt_factory
:members:
:special-members: __init__
.. automodule:: ml.tools
:members:
:special-members: __init__
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment