docs: Quick docgen streamlining
parent
02c63e3b8f
commit
18abfd4296
|
@ -3,4 +3,4 @@ _site
|
|||
_sidebar.yml
|
||||
_site
|
||||
objects.json
|
||||
reference
|
||||
pydocs
|
||||
|
|
176
doc/_quarto.yml
176
doc/_quarto.yml
|
@ -1,11 +1,38 @@
|
|||
project:
|
||||
type: website
|
||||
|
||||
# Website Configuration
|
||||
website:
|
||||
page-footer: "Copyright 2024, Sofus Albert Høgsbro Rose"
|
||||
navbar:
|
||||
left:
|
||||
- file: index.qmd
|
||||
text: Home
|
||||
- file: pydocs/index.qmd
|
||||
text: Reference
|
||||
tools:
|
||||
- icon: github
|
||||
menu:
|
||||
- text: Source Code
|
||||
url: https://github.com/so-rose/blender_maxwell/
|
||||
- text: Report a Bug
|
||||
url: https://github.com/so-rose/blender_maxwell/issues/new/choose
|
||||
|
||||
# Auto-Generated Metadata
|
||||
metadata-files:
|
||||
- _sidebar.yml
|
||||
# Sidebar for /pydocs Paths
|
||||
- pydocs/_sidebar.yml
|
||||
|
||||
|
||||
####################
|
||||
# - quartodoc - Autogenerated Python Docs
|
||||
####################
|
||||
quartodoc:
|
||||
# Output
|
||||
dir: pydocs
|
||||
#out_index: _api_index.qmd
|
||||
sidebar: pydocs/_sidebar.yml
|
||||
|
||||
# Python Package
|
||||
source_dir: ../src
|
||||
package: blender_maxwell
|
||||
|
@ -13,17 +40,150 @@ quartodoc:
|
|||
|
||||
# Style
|
||||
style: pkgdown
|
||||
title: Package Reference
|
||||
title: "Blender Maxwell"
|
||||
|
||||
# Write Sidebar Data to Dedicated Metadata File
|
||||
sidebar: _sidebar.yml
|
||||
# Options
|
||||
options:
|
||||
include_private: true
|
||||
include_empty: true
|
||||
include_attributes: true
|
||||
signature_name: "short"
|
||||
|
||||
sections:
|
||||
- title: Blender Maxwell API
|
||||
desc: Root package for the Blender Maxwell addon
|
||||
- title: "`scripts`"
|
||||
desc: Build/packaging scripts for developing and publishing the addon.
|
||||
package: scripts
|
||||
contents:
|
||||
- register
|
||||
- unregister
|
||||
- name: info
|
||||
children: embedded
|
||||
- name: pack
|
||||
children: embedded
|
||||
- name: dev
|
||||
children: embedded
|
||||
- name: bl_delete_addon
|
||||
children: embedded
|
||||
- name: bl_install_addon
|
||||
children: embedded
|
||||
|
||||
- title: "`bl_maxwell`"
|
||||
desc: Root package for the addon.
|
||||
contents:
|
||||
- name: info
|
||||
children: embedded
|
||||
- name: preferences
|
||||
children: embedded
|
||||
- name: registration
|
||||
children: embedded
|
||||
|
||||
- subtitle: "`bl_maxwell.assets`"
|
||||
desc: Blender assets bundled w/Blender Maxwell
|
||||
contents:
|
||||
- name: assets
|
||||
children: embedded
|
||||
- name: assets.import_geonodes
|
||||
children: embedded
|
||||
|
||||
- subtitle: "`bl_maxwell.nodeps`"
|
||||
desc: No-Dependency
|
||||
contents:
|
||||
- name: operators
|
||||
children: embedded
|
||||
|
||||
- subtitle: "`bl_maxwell.utils`"
|
||||
desc: Utilities wo/shared global state.
|
||||
contents:
|
||||
- name: utils.analyze_geonodes
|
||||
children: embedded
|
||||
- name: utils.blender_type_enum
|
||||
children: embedded
|
||||
- name: utils.extra_sympy_units
|
||||
children: embedded
|
||||
- name: utils.logger
|
||||
children: embedded
|
||||
- name: utils.pydantic_sympy
|
||||
children: embedded
|
||||
|
||||
- subtitle: "`bl_maxwell.services`"
|
||||
desc: Utilities w/shared global state.
|
||||
contents:
|
||||
- name: services.tdcloud
|
||||
children: embedded
|
||||
|
||||
- subtitle: "`bl_maxwell.operators`"
|
||||
desc: General Blender operators.
|
||||
contents:
|
||||
- name: operators.bl_append
|
||||
children: embedded
|
||||
- name: operators.connect_viewer
|
||||
children: embedded
|
||||
|
||||
# Node Tree
|
||||
- title: "`..maxwell_sim_nodes`"
|
||||
desc: Maxwell Simulation Design/Viz Node Tree.
|
||||
package: blender_maxwell.node_trees.maxwell_sim_nodes
|
||||
contents:
|
||||
- name: bl_socket_map
|
||||
children: embedded
|
||||
- name: categories
|
||||
children: embedded
|
||||
- name: node_tree
|
||||
children: embedded
|
||||
|
||||
- subtitle: "`contracts`"
|
||||
desc: Constants and interfaces for identifying resources.
|
||||
package: blender_maxwell.node_trees.maxwell_sim_nodes.contracts
|
||||
contents:
|
||||
# General
|
||||
- name: bl
|
||||
children: embedded
|
||||
- name: data_flows
|
||||
children: embedded
|
||||
- name: icons
|
||||
children: embedded
|
||||
|
||||
- name: trees
|
||||
children: embedded
|
||||
|
||||
# Managed Objects
|
||||
- name: managed_obj_type
|
||||
children: embedded
|
||||
|
||||
# Nodes
|
||||
- name: node_types
|
||||
children: embedded
|
||||
- name: node_cats
|
||||
children: embedded
|
||||
- name: node_cat_labels
|
||||
children: embedded
|
||||
|
||||
# Sockets
|
||||
- name: socket_types
|
||||
children: embedded
|
||||
- name: socket_colors
|
||||
children: embedded
|
||||
- name: socket_from_bl_desc
|
||||
children: embedded
|
||||
- name: socket_from_bl_direct
|
||||
children: embedded
|
||||
- name: socket_shapes
|
||||
children: embedded
|
||||
- name: socket_units
|
||||
children: embedded
|
||||
|
||||
- name: unit_systems
|
||||
children: embedded
|
||||
|
||||
- subtitle: "`managed_objs`"
|
||||
desc: Maxwell Simulation Design/Viz Node Tree
|
||||
package: blender_maxwell.node_trees.maxwell_sim_nodes.managed_objs
|
||||
contents:
|
||||
- name: managed_bl_collection
|
||||
children: embedded
|
||||
- name: managed_bl_empty
|
||||
children: embedded
|
||||
- name: managed_bl_image
|
||||
children: embedded
|
||||
- name: managed_bl_mesh
|
||||
children: embedded
|
||||
- name: managed_bl_modifier
|
||||
children: embedded
|
||||
|
|
Loading…
Reference in New Issue