lingyuzeng
3e07402f4e
Add a public numbering module and route fragmenting, validation, and scaffold preparation through the canonical numbering entry. Rewrite the repository entry docs around the fixed numbering contract, add MkDocs landing pages, and document the mirror mapping used for medicinal-chemistry comparisons. Also refresh the validation analysis reports to explain the canonical-versus-mirrored numbering relationship.
180 lines
4.2 KiB
YAML
180 lines
4.2 KiB
YAML
site_name: Macrolactone Fragmenter
|
|
site_description: A comprehensive tool for analyzing and fragmenting macrolactone (12-20 membered ring) side chains
|
|
site_author: Macro Split Team
|
|
site_url: https://yourusername.github.io/macro_split/
|
|
|
|
# Repository
|
|
repo_name: yourusername/macro_split
|
|
repo_url: https://github.com/yourusername/macro_split
|
|
edit_uri: edit/main/docs/
|
|
|
|
# Copyright
|
|
copyright: Copyright © 2025 Macro Split Team
|
|
|
|
# Configuration
|
|
theme:
|
|
name: material
|
|
language: zh
|
|
palette:
|
|
# Light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
# Dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.indexes
|
|
- navigation.top
|
|
- search.suggest
|
|
- search.highlight
|
|
- search.share
|
|
- toc.follow
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
edit: material/pencil
|
|
view: material/eye
|
|
|
|
# Extensions
|
|
markdown_extensions:
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- toc:
|
|
permalink: true
|
|
toc_depth: 3
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
|
|
# Plugins
|
|
plugins:
|
|
- search:
|
|
lang:
|
|
- zh
|
|
- en
|
|
- mkdocstrings:
|
|
enabled: true
|
|
default_handler: python
|
|
handlers:
|
|
python:
|
|
options:
|
|
docstring_style: google
|
|
docstring_section_style: table
|
|
show_root_heading: true
|
|
show_root_toc_entry: true
|
|
show_source: true
|
|
show_symbol_type_heading: true
|
|
show_symbol_type_toc: true
|
|
members_order: source
|
|
heading_level: 2
|
|
show_if_no_docstring: false
|
|
|
|
# Extra CSS and JavaScript
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
extra_javascript:
|
|
- javascripts/mathjax.js
|
|
- https://polyfill.io/v3/polyfill.min.js?features=es6
|
|
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
|
|
|
|
# Page tree
|
|
nav:
|
|
- 首页:
|
|
- index.md
|
|
- 快速开始: getting-started.md
|
|
|
|
- 用户指南:
|
|
- user-guide/index.md
|
|
- 环编号系统: user-guide/ring-numbering.md
|
|
|
|
- 开发者指南:
|
|
- development/index.md
|
|
- 项目结构: development/project-structure.md
|
|
|
|
- 项目文档:
|
|
- project-docs/AGENTS.md
|
|
|
|
not_in_nav: |
|
|
/SUMMARY.md
|
|
/plans/
|
|
/project-docs/CLEANUP_SUMMARY.md
|
|
/project-docs/DOCUMENTATION_GUIDE.md
|
|
/project-docs/IMPLEMENTATION_SUMMARY.md
|
|
/project-docs/QUICK_COMMANDS.md
|
|
|
|
# Extra
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/yourusername/macro_split
|
|
- icon: fontawesome/brands/python
|
|
link: https://pypi.org/project/macrolactone-fragmenter/
|
|
|
|
version:
|
|
provider: mike
|
|
default: latest
|
|
|
|
analytics:
|
|
feedback:
|
|
title: Was this page helpful?
|
|
ratings:
|
|
- icon: material/emoticon-happy-outline
|
|
name: This page was helpful
|
|
data: 1
|
|
note: >-
|
|
Thanks for your feedback!
|
|
- icon: material/emoticon-sad-outline
|
|
name: This page could be improved
|
|
data: 0
|
|
note: >-
|
|
Thanks for your feedback! Help us improve this page by
|
|
creating an issue.
|