Skip to content

Commit

Permalink
Start toward Sphinx use
Browse files Browse the repository at this point in the history
  • Loading branch information
zimeon committed Sep 15, 2024
1 parent 7e8b3bc commit 0b9d883
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
1 change: 0 additions & 1 deletion docs/conf.py

This file was deleted.

36 changes: 36 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Configuration file for the Sphinx documentation builder.

# -- Project information

project = 'ocfl-py'

# -- General configuration

extensions = [
"myst_parser",
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
]

autodoc_default_options = {
'members': 'ocfl',
'member-order': 'bysource',
'special-members': '__init__',
'undoc-members': True,
'exclude-members': '__weakref__'
}

intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']

templates_path = ['_templates']

# -- Options for HTML output

html_theme = 'sphinx_rtd_theme'

0 comments on commit 0b9d883

Please sign in to comment.