Skip to content

Commit 875985b

Browse files
cakcak
committed
Add great-docs.yml configuration file
1 parent 8578268 commit 875985b

1 file changed

Lines changed: 366 additions & 0 deletions

File tree

‎great-docs.yml‎

Lines changed: 366 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,366 @@
1+
# Great Docs Configuration
2+
# See https://posit-dev.github.io/great-docs/user-guide/configuration.html
3+
4+
# Module Name (optional)
5+
# ----------------------
6+
# Set this if your importable module name differs from the project name.
7+
# Example: project 'py-yaml12' with module name 'yaml12'
8+
# module: yaml12
9+
10+
# Docstring Parser
11+
# ----------------
12+
# The docstring format used in your package (numpy, google, or sphinx)
13+
parser: numpy
14+
15+
# Dynamic Introspection
16+
# ---------------------
17+
# Use runtime introspection for more accurate documentation (default: true)
18+
# Set to false if your package has cyclic alias issues (e.g., PyO3/Rust bindings)
19+
dynamic: false
20+
21+
# API Discovery Settings
22+
# ----------------------
23+
# Exclude items from auto-documentation
24+
# exclude:
25+
# - InternalClass
26+
# - helper_function
27+
28+
# Logo & Favicon
29+
# ---------------
30+
# Point to a single logo file (replaces the text title in the navbar):
31+
# logo: assets/logo.svg
32+
#
33+
# For light/dark variants:
34+
# logo:
35+
# light: assets/logo-light.svg
36+
# dark: assets/logo-dark.svg
37+
#
38+
# To show the text title alongside the logo, add: show_title: true
39+
40+
# Author Information
41+
# ------------------
42+
# Author metadata for display in the landing page sidebar
43+
# You can add additional fields: github, orcid, affiliation, homepage
44+
authors:
45+
- name: Caleb Kinney
46+
role: Author
47+
# affiliation:
48+
email: caleb@typeerror.com
49+
github: https://github.com/cak
50+
# orcid:
51+
homepage: https://typeerror.com
52+
53+
# Funding / Copyright Holder
54+
# --------------------------
55+
# Credit the organization that funds or holds copyright for this package.
56+
# Displays in sidebar and footer. Homepage and ROR provide links.
57+
# funding:
58+
# name: "Posit Software, PBC"
59+
# roles:
60+
# - Copyright holder
61+
# - funder
62+
# homepage: https://posit.co
63+
# ror: https://ror.org/03wc8by49
64+
65+
# API Reference Structure
66+
# -----------------------
67+
# Customize the sections below to organize your API documentation.
68+
# - Reorder items within a section to change their display order
69+
# - Move items between sections or create new sections
70+
# - Use 'members: false' to exclude methods from documentation
71+
# - Add 'desc:' to sections for descriptions
72+
73+
reference:
74+
- title: Classes
75+
desc: Main classes provided by the package
76+
contents:
77+
- name: Secure
78+
members: false # 10 methods listed below
79+
80+
- title: Dataclasses
81+
desc: Dataclass definitions
82+
contents:
83+
- name: CacheControl
84+
members: false # 21 methods listed below
85+
- name: ContentSecurityPolicy
86+
members: false # 37 methods listed below
87+
- name: CrossOriginEmbedderPolicy
88+
members: false # 6 methods listed below
89+
- name: CrossOriginOpenerPolicy
90+
members: false # 8 methods listed below
91+
- name: CrossOriginResourcePolicy
92+
members: false # 6 methods listed below
93+
- CustomHeader # 2 method(s)
94+
- name: PermissionsPolicy
95+
members: false # 53 methods listed below
96+
- name: ReferrerPolicy
97+
members: false # 14 methods listed below
98+
- Server # 3 method(s)
99+
- StrictTransportSecurity # 5 method(s)
100+
- XContentTypeOptions # 4 method(s)
101+
- name: XDnsPrefetchControl
102+
members: false # 8 methods listed below
103+
- name: XFrameOptions
104+
members: false # 7 methods listed below
105+
- name: XPermittedCrossDomainPolicies
106+
members: false # 11 methods listed below
107+
108+
- title: Secure Methods
109+
desc: Methods for the Secure class
110+
contents:
111+
- Secure.with_default_headers
112+
- Secure.from_preset
113+
- Secure.__str__
114+
- Secure.__repr__
115+
- Secure.validate_and_normalize_headers
116+
- Secure.deduplicate_headers
117+
- Secure.allowlist_headers
118+
- Secure.header_items
119+
- Secure.set_headers
120+
- Secure.set_headers_async
121+
122+
- title: CacheControl Methods
123+
desc: Methods for the CacheControl class
124+
contents:
125+
- CacheControl.value
126+
- CacheControl.set
127+
- CacheControl.clear
128+
- CacheControl.custom
129+
- CacheControl.immutable
130+
- CacheControl.max_age
131+
- CacheControl.max_stale
132+
- CacheControl.min_fresh
133+
- CacheControl.must_revalidate
134+
- CacheControl.must_understand
135+
- CacheControl.no_cache
136+
- CacheControl.no_store
137+
- CacheControl.no_transform
138+
- CacheControl.only_if_cached
139+
- CacheControl.private
140+
- CacheControl.proxy_revalidate
141+
- CacheControl.public
142+
- CacheControl.s_maxage
143+
- CacheControl.s_max_age
144+
- CacheControl.stale_if_error
145+
- CacheControl.stale_while_revalidate
146+
147+
- title: ContentSecurityPolicy Methods
148+
desc: Methods for the ContentSecurityPolicy class
149+
contents:
150+
- ContentSecurityPolicy.value
151+
- ContentSecurityPolicy.set
152+
- ContentSecurityPolicy.clear
153+
- ContentSecurityPolicy.report_only
154+
- ContentSecurityPolicy.enforce
155+
- ContentSecurityPolicy.custom
156+
- ContentSecurityPolicy.custom_directive
157+
- ContentSecurityPolicy.base_uri
158+
- ContentSecurityPolicy.block_all_mixed_content
159+
- ContentSecurityPolicy.child_src
160+
- ContentSecurityPolicy.connect_src
161+
- ContentSecurityPolicy.default_src
162+
- ContentSecurityPolicy.fenced_frame_src
163+
- ContentSecurityPolicy.font_src
164+
- ContentSecurityPolicy.form_action
165+
- ContentSecurityPolicy.frame_ancestors
166+
- ContentSecurityPolicy.frame_src
167+
- ContentSecurityPolicy.img_src
168+
- ContentSecurityPolicy.manifest_src
169+
- ContentSecurityPolicy.media_src
170+
- ContentSecurityPolicy.object_src
171+
- ContentSecurityPolicy.prefetch_src
172+
- ContentSecurityPolicy.report_to
173+
- ContentSecurityPolicy.report_uri
174+
- ContentSecurityPolicy.require_trusted_types_for
175+
- ContentSecurityPolicy.sandbox
176+
- ContentSecurityPolicy.script_src
177+
- ContentSecurityPolicy.script_src_attr
178+
- ContentSecurityPolicy.script_src_elem
179+
- ContentSecurityPolicy.style_src
180+
- ContentSecurityPolicy.style_src_attr
181+
- ContentSecurityPolicy.style_src_elem
182+
- ContentSecurityPolicy.trusted_types
183+
- ContentSecurityPolicy.upgrade_insecure_requests
184+
- ContentSecurityPolicy.worker_src
185+
- ContentSecurityPolicy.keyword
186+
- ContentSecurityPolicy.nonce
187+
188+
- title: CrossOriginEmbedderPolicy Methods
189+
desc: Methods for the CrossOriginEmbedderPolicy class
190+
contents:
191+
- CrossOriginEmbedderPolicy.set
192+
- CrossOriginEmbedderPolicy.value
193+
- CrossOriginEmbedderPolicy.clear
194+
- CrossOriginEmbedderPolicy.unsafe_none
195+
- CrossOriginEmbedderPolicy.require_corp
196+
- CrossOriginEmbedderPolicy.credentialless
197+
198+
- title: CrossOriginOpenerPolicy Methods
199+
desc: Methods for the CrossOriginOpenerPolicy class
200+
contents:
201+
- CrossOriginOpenerPolicy.value
202+
- CrossOriginOpenerPolicy.custom
203+
- CrossOriginOpenerPolicy.set
204+
- CrossOriginOpenerPolicy.clear
205+
- CrossOriginOpenerPolicy.unsafe_none
206+
- CrossOriginOpenerPolicy.same_origin_allow_popups
207+
- CrossOriginOpenerPolicy.same_origin
208+
- CrossOriginOpenerPolicy.noopener_allow_popups
209+
210+
- title: CrossOriginResourcePolicy Methods
211+
desc: Methods for the CrossOriginResourcePolicy class
212+
contents:
213+
- CrossOriginResourcePolicy.clear
214+
- CrossOriginResourcePolicy.value
215+
- CrossOriginResourcePolicy.set
216+
- CrossOriginResourcePolicy.same_origin
217+
- CrossOriginResourcePolicy.same_site
218+
- CrossOriginResourcePolicy.cross_origin
219+
220+
- title: PermissionsPolicy Methods
221+
desc: Methods for the PermissionsPolicy class
222+
contents:
223+
- PermissionsPolicy.value
224+
- PermissionsPolicy.set
225+
- PermissionsPolicy.clear
226+
- PermissionsPolicy.add_directive
227+
- PermissionsPolicy.directive
228+
- PermissionsPolicy.accelerometer
229+
- PermissionsPolicy.ambient_light_sensor
230+
- PermissionsPolicy.aria_notify
231+
- PermissionsPolicy.attribution_reporting
232+
- PermissionsPolicy.autoplay
233+
- PermissionsPolicy.bluetooth
234+
- PermissionsPolicy.browsing_topics
235+
- PermissionsPolicy.compute_pressure
236+
- PermissionsPolicy.cross_origin_isolated
237+
- PermissionsPolicy.fullscreen
238+
- PermissionsPolicy.gamepad
239+
- PermissionsPolicy.geolocation
240+
- PermissionsPolicy.gyroscope
241+
- PermissionsPolicy.hid
242+
- PermissionsPolicy.identity_credentials_get
243+
- PermissionsPolicy.idle_detection
244+
- PermissionsPolicy.local_fonts
245+
- PermissionsPolicy.magnetometer
246+
- PermissionsPolicy.microphone
247+
- PermissionsPolicy.on_device_speech_recognition
248+
- PermissionsPolicy.otp_credentials
249+
- PermissionsPolicy.publickey_credentials_create
250+
- PermissionsPolicy.publickey_credentials_get
251+
- PermissionsPolicy.serial
252+
- PermissionsPolicy.speaker_selection
253+
- PermissionsPolicy.storage_access
254+
- PermissionsPolicy.summarizer
255+
- PermissionsPolicy.translator
256+
- PermissionsPolicy.language_detector
257+
- PermissionsPolicy.usb
258+
- PermissionsPolicy.web_share
259+
- PermissionsPolicy.window_management
260+
- PermissionsPolicy.xr_spatial_tracking
261+
- PermissionsPolicy.battery
262+
- PermissionsPolicy.camera
263+
- PermissionsPolicy.clipboard_read
264+
- PermissionsPolicy.clipboard_write
265+
- PermissionsPolicy.display_capture
266+
- PermissionsPolicy.document_domain
267+
- PermissionsPolicy.encrypted_media
268+
- PermissionsPolicy.execution_while_not_rendered
269+
- PermissionsPolicy.execution_while_out_of_viewport
270+
- PermissionsPolicy.midi
271+
- PermissionsPolicy.navigation_override
272+
- PermissionsPolicy.payment
273+
- PermissionsPolicy.picture_in_picture
274+
- PermissionsPolicy.screen_wake_lock
275+
- PermissionsPolicy.sync_xhr
276+
277+
- title: ReferrerPolicy Methods
278+
desc: Methods for the ReferrerPolicy class
279+
contents:
280+
- ReferrerPolicy.add
281+
- ReferrerPolicy.set
282+
- ReferrerPolicy.value
283+
- ReferrerPolicy.custom
284+
- ReferrerPolicy.fallback
285+
- ReferrerPolicy.clear
286+
- ReferrerPolicy.no_referrer
287+
- ReferrerPolicy.no_referrer_when_downgrade
288+
- ReferrerPolicy.origin
289+
- ReferrerPolicy.origin_when_cross_origin
290+
- ReferrerPolicy.same_origin
291+
- ReferrerPolicy.strict_origin
292+
- ReferrerPolicy.strict_origin_when_cross_origin
293+
- ReferrerPolicy.unsafe_url
294+
295+
- title: XDnsPrefetchControl Methods
296+
desc: Methods for the XDnsPrefetchControl class
297+
contents:
298+
- XDnsPrefetchControl.clear
299+
- XDnsPrefetchControl.set
300+
- XDnsPrefetchControl.value
301+
- XDnsPrefetchControl.custom
302+
- XDnsPrefetchControl.on
303+
- XDnsPrefetchControl.off
304+
- XDnsPrefetchControl.allow
305+
- XDnsPrefetchControl.disable
306+
307+
- title: XFrameOptions Methods
308+
desc: Methods for the XFrameOptions class
309+
contents:
310+
- XFrameOptions.value
311+
- XFrameOptions.set
312+
- XFrameOptions.custom
313+
- XFrameOptions.clear
314+
- XFrameOptions.deny
315+
- XFrameOptions.sameorigin
316+
- XFrameOptions.allow_from
317+
318+
- title: XPermittedCrossDomainPolicies Methods
319+
desc: Methods for the XPermittedCrossDomainPolicies class
320+
contents:
321+
- XPermittedCrossDomainPolicies.clear
322+
- XPermittedCrossDomainPolicies.value
323+
- XPermittedCrossDomainPolicies.custom
324+
- XPermittedCrossDomainPolicies.set
325+
- XPermittedCrossDomainPolicies.policy
326+
- XPermittedCrossDomainPolicies.none
327+
- XPermittedCrossDomainPolicies.master_only
328+
- XPermittedCrossDomainPolicies.by_content_type
329+
- XPermittedCrossDomainPolicies.by_ftp_filename
330+
- XPermittedCrossDomainPolicies.all
331+
- XPermittedCrossDomainPolicies.none_this_response
332+
333+
- title: Enumerations
334+
desc: Enumeration types
335+
contents:
336+
- Preset
337+
338+
# Site URL
339+
# --------
340+
# Canonical address of the deployed documentation site.
341+
# Required for subdirectory deployments, skills page install commands,
342+
# .well-known/ discovery, and sitemaps.
343+
site_url: "https://typeerror.com/secure/"
344+
345+
# Site Settings
346+
# -------------
347+
# site:
348+
# theme: flatly # Quarto theme (default: flatly)
349+
# toc: true # Show table of contents (default: true)
350+
# toc-depth: 2 # TOC heading depth (default: 2)
351+
# toc-title: On this page # TOC title (default: "On this page")
352+
353+
# Jupyter Kernel
354+
# --------------
355+
# Jupyter kernel to use for executing code cells in .qmd files.
356+
# This is set at the project level so it applies to all pages, including
357+
# auto-generated API reference pages. Can be overridden in individual .qmd
358+
# file frontmatter if needed for special cases.
359+
jupyter: python3
360+
361+
# CLI Documentation
362+
# -----------------
363+
# cli:
364+
# enabled: true # Enable CLI documentation
365+
# module: my_package.cli # Module containing Click commands
366+
# name: cli # Name of the Click command object

0 commit comments

Comments
 (0)