Skip to content

Commit c30ec75

Browse files
bltravisbtravisebsco
authored andcommitted
Update Read the Docs configuration and remove obsolete reference documentation
1 parent 0438299 commit c30ec75

4 files changed

Lines changed: 79 additions & 27 deletions

File tree

.readthedocs.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44

55
version: 2
66

7+
sphinx:
8+
configuration: docs/source/conf.py
9+
fail_on_warning: false
10+
11+
formats:
12+
- htmlzip
13+
714
build:
815
os: ubuntu-22.04
916
tools:
@@ -14,10 +21,3 @@ python:
1421
- method: pip
1522
path: .
1623
- requirements: docs/requirements.txt
17-
18-
sphinx:
19-
configuration: docs/conf.py
20-
fail_on_warning: false
21-
22-
formats:
23-
- htmlzip

docs/reference.rst

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/source/api_reference.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ The core module for batch posting inventory records to FOLIO.
1515
:members:
1616
:undoc-members:
1717
:show-inheritance:
18+
:noindex:
1819

1920
MARCDataImport
2021
~~~~~~~~~~~~~~
@@ -25,6 +26,7 @@ Module for importing MARC records using FOLIO's Data Import APIs.
2526
:members:
2627
:undoc-members:
2728
:show-inheritance:
29+
:noindex:
2830

2931
UserImport
3032
~~~~~~~~~~
@@ -35,6 +37,7 @@ Module for importing user data into FOLIO.
3537
:members:
3638
:undoc-members:
3739
:show-inheritance:
40+
:noindex:
3841

3942
Custom Exceptions
4043
~~~~~~~~~~~~~~~~~
@@ -45,6 +48,7 @@ Exception classes used throughout the toolkit.
4548
:members:
4649
:undoc-members:
4750
:show-inheritance:
51+
:noindex:
4852

4953
Progress Reporting
5054
~~~~~~~~~~~~~~~~~~
@@ -55,6 +59,7 @@ Progress tracking and reporting utilities.
5559
:members:
5660
:undoc-members:
5761
:show-inheritance:
62+
:noindex:
5863

5964
MARC Preprocessors
6065
~~~~~~~~~~~~~~~~~~
@@ -65,6 +70,7 @@ MARC record preprocessor functions.
6570
:members:
6671
:undoc-members:
6772
:show-inheritance:
73+
:noindex:
6874

6975
See Also
7076
--------

docs/source/conf.py

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# docs/conf.py
2+
import datetime
3+
import os
4+
import sys
5+
6+
"""Sphinx configuration."""
7+
project = "FOLIO Data Import"
8+
author = "EBSCO Information Services"
9+
copyright = f"{datetime.date.today().year}, {author}"
10+
11+
# Path setup - add the source directory to sys.path
12+
sys.path.insert(0, os.path.abspath("../src"))
13+
14+
# Master document
15+
master_doc = "index"
16+
17+
extensions = [
18+
"myst_parser",
19+
"sphinx.ext.autodoc",
20+
"sphinx.ext.autosummary",
21+
"sphinx.ext.napoleon",
22+
"sphinx_autodoc_typehints",
23+
"sphinx_design",
24+
]
25+
26+
# Napoleon settings for Google-style docstrings
27+
napoleon_google_docstring = True
28+
napoleon_numpy_docstring = True
29+
napoleon_include_init_with_doc = True
30+
napoleon_include_private_with_doc = False
31+
napoleon_include_special_with_doc = True
32+
napoleon_use_admonition_for_examples = True
33+
napoleon_use_admonition_for_notes = True
34+
napoleon_use_admonition_for_references = False
35+
napoleon_use_ivar = False
36+
napoleon_use_param = True
37+
napoleon_use_rtype = True
38+
napoleon_preprocess_types = True
39+
html_theme = "sphinx_book_theme"
40+
myst_heading_anchors = 3
41+
html_theme_options = {
42+
"repository_url": "https://github.com/folio-fse/folio_data_import",
43+
"use_repository_button": True,
44+
"show_navbar_depth": 2,
45+
"max_navbar_depth": 3,
46+
"show_nav_level": 2,
47+
"collapse_navigation": True,
48+
}
49+
myst_enable_extensions = [
50+
"deflist",
51+
"colon_fence",
52+
]
53+
54+
# Autodoc settings
55+
autodoc_default_options = {
56+
"members": True,
57+
"undoc-members": True,
58+
"show-inheritance": True,
59+
}
60+
autodoc_member_order = "bysource"
61+
62+
source_suffix = {
63+
".rst": "restructuredtext",
64+
".txt": "markdown",
65+
".md": "markdown",
66+
}

0 commit comments

Comments
 (0)