Skip to content
Snippets Groups Projects
Commit 6d43313c authored by Yngve Levinsen's avatar Yngve Levinsen
Browse files

allow numpy/google style documentation

fieldmap already documented this way
parent a05a7382
No related branches found
No related tags found
No related merge requests found
...@@ -7,7 +7,7 @@ repos: ...@@ -7,7 +7,7 @@ repos:
rev: v1.3.0 rev: v1.3.0
hooks: hooks:
- id: flake8 - id: flake8
args: ['--max-line-length=140', '--ignore=E203'] args: ['--max-line-length=140', '--ignore=E203,E402']
- repo: https://github.com/pre-commit/mirrors-mypy - repo: https://github.com/pre-commit/mirrors-mypy
rev: 'v0.720' rev: 'v0.720'
hooks: hooks:
......
...@@ -20,9 +20,9 @@ ...@@ -20,9 +20,9 @@
import os import os
import sys import sys
from typing import List from typing import List
from ess import __version__
sys.path.insert(0, os.path.abspath("../")) sys.path.insert(0, os.path.abspath("../"))
from ess import __version__
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
...@@ -36,6 +36,7 @@ sys.path.insert(0, os.path.abspath("../")) ...@@ -36,6 +36,7 @@ sys.path.insert(0, os.path.abspath("../"))
extensions = [ extensions = [
"sphinx.ext.autodoc", "sphinx.ext.autodoc",
"sphinx.ext.intersphinx", "sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"sphinx.ext.todo", "sphinx.ext.todo",
"sphinx.ext.coverage", "sphinx.ext.coverage",
"sphinx.ext.mathjax", "sphinx.ext.mathjax",
...@@ -44,6 +45,11 @@ extensions = [ ...@@ -44,6 +45,11 @@ extensions = [
"sphinxcontrib.restbuilder", "sphinxcontrib.restbuilder",
] ]
# set napoleon style docstring
napoleon_google_docstring = False
napoleon_use_param = False
napoleon_use_ivar = True
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"] templates_path = ["_templates"]
...@@ -133,7 +139,8 @@ todo_include_todos = True ...@@ -133,7 +139,8 @@ todo_include_todos = True
# a list of builtin themes. # a list of builtin themes.
# #
# html_theme = 'alabaster' # html_theme = 'alabaster'
html_theme = "sphinxdoc" # html_theme = "sphinxdoc"
html_theme = "sphinx_rtd_theme"
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
...@@ -262,41 +269,6 @@ man_pages = [ ...@@ -262,41 +269,6 @@ man_pages = [
# #
# man_show_urls = False # man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc,
"ESSPythonTools",
"ESS Python Tools Documentation",
author,
"ESSPythonTools",
"One line description of project.",
"Miscellaneous",
)
]
# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []
# If false, no module index is generated.
#
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False
# Example configuration for intersphinx: refer to the Python standard library. # Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"https://docs.python.org/": None} intersphinx_mapping = {"https://docs.python.org/": None}
......
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