1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# SPDX-FileCopyrightText: 2025 Helge Eichhorn <git@helgeeichhorn.de>
#
# SPDX-License-Identifier: MPL-2.0
site_name: Lox Python
site_url: https://python.lox.rs
repo_url: https://github.com/lox-space/lox
nav:
- Home: index.md
- API Reference:
- Time & Dates: time.md
- Celestial Bodies: bodies.md
- Reference Frames: frames.md
- Orbital States: states.md
- Propagators: propagators.md
- Ground Stations: ground.md
- Events & Visibility: events.md
- Communications: comms.md
- Constellations: constellations.md
- Data Providers: data.md
- Units: units.md
theme:
name: material
palette:
scheme: slate
primary: indigo
markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
plugins:
- mkdocstrings:
handlers:
python:
# Where to find your sources, see "Finding modules".
# paths: [src]
# Load object inventories to enable cross-references to other projects.
inventories:
- https://docs.python.org/3/objects.inv
# Also load inventories of your dependencies, generally served at
# https://docs-url-for-your-dependency/objects.inv.
options:
# DOCSTRINGS -------------------------------------------------------------
docstring_options:
# Discard first line of `__init__` method docstrings,
# useful when merging such docstrings into their parent class'.
ignore_init_summary: true
# Suppress warnings for parameters documented in docstrings
# that are not visible in compiled PyO3 extension signatures.
warn_unknown_params: false
# Suppress warnings for missing type annotations in docstrings
# (types are provided in the .pyi stub file instead).
warn_missing_types: false
# Tables are generally too large, lists will fix this.
docstring_section_style: list
# CROSS-REFERENCES -------------------------------------------------------
# Enable relative crossrefs and scoped crossrefs, see Docstrings options.
# relative_crossrefs: true # Sponsors only!
# scoped_crossrefs: true # Sponsors only!
# Enable cross-references in signatures.
signature_crossrefs: true
# Unwrap actual types from `Annotated` type annotations.
unwrap_annotated: true
# MEMBERS ----------------------------------------------------------------
# Only render pulic symbols.
# filters: public # Sponsors only!
# Comment the option otherwise to get the default filters.
# Show class inherited members.
inherited_members: true
# Render auto-generated summaries of attributes, functions, etc.
# at the start of each symbol's documentation.
summary: true
# HEADINGS ---------------------------------------------------------------
# For auto-generated pages, one module per page,
# make the module heading be the H1 heading of the page.
heading_level: 1
# Render headings for parameters, making them linkable.
parameter_headings: true
# Render headings for type parameters too.
type_parameter_headings: true
# Always show the heading for the symbol you render with `::: id`.
show_root_heading: true
# Only show the name of the symbols you inject render `::: id`.
show_root_full_path: false
# Show the type of symbol (class, function, etc.) in the heading.
show_symbol_type_heading: true
# Show the type of symbol (class, function, etc.) in the table of contents.
show_symbol_type_toc: true
# SIGNATURES -------------------------------------------------------------
# Format code to 80 + 10% margin (Black and Ruff defaults)
# in signatures and attribute value code blocks.
# Needs Black/Ruff installed.
line_length: 88
# Merge signature and docstring of `__init__` methods
# into their parent class signature and docstring.
merge_init_into_class: true
# Render signatures and attribute values in a separate code block,
# below the symbol heading.
separate_signature: true
# Show type annotations in signatures.
show_signature_annotations: true
# Show type parameters in signatures.
show_signature_type_parameters: true
# OTHER ------------------------------------------------------------------
# Show backlinks to other documentation sections within each symbol.
# backlinks: tree # Sponsors only!
# Show base classes OR inheritance diagram.
show_bases: false
# show_inheritance_diagram: true # Sponsors only!