[{"data":1,"prerenderedAt":496},["ShallowReactive",2],{"navigation":3,"api-navigation":109,"\u002Fdocs\u002Fcomparison\u002Fsphinx":110,"docyard:crossref-index":485},[4,14,97,101,105],{"title":5,"path":6,"stem":7,"children":8,"page":13},"Authoring","\u002Fauthoring","authoring",[9],{"title":10,"path":11,"stem":12},"Markdoc","\u002Fauthoring\u002Fmarkdoc","authoring\u002Fmarkdoc",false,{"title":15,"path":16,"stem":17,"children":18},"Docs","\u002Fdocs","docs",[19,22,26,30,34,55,59,63,93],{"title":20,"path":16,"stem":21},"Documentation","docs\u002Findex",{"title":23,"path":24,"stem":25},"Getting Started","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started",{"title":27,"path":28,"stem":29},"Flake Module","\u002Fdocs\u002Fflake-module","docs\u002F2.flake-module",{"title":31,"path":32,"stem":33},"CLI Reference","\u002Fdocs\u002Fcli","docs\u002F3.cli",{"title":5,"path":35,"stem":36,"children":37},"\u002Fdocs\u002Fauthoring","docs\u002F4.authoring\u002Findex",[38,39,43,47,51],{"title":5,"path":35,"stem":36},{"title":40,"path":41,"stem":42},"Quarto Files","\u002Fdocs\u002Fauthoring\u002Fquarto","docs\u002F4.authoring\u002F1.quarto",{"title":44,"path":45,"stem":46},"Citations","\u002Fdocs\u002Fauthoring\u002Fcitations","docs\u002F4.authoring\u002F2.citations",{"title":48,"path":49,"stem":50},"Callouts","\u002Fdocs\u002Fauthoring\u002Fcallouts","docs\u002F4.authoring\u002F3.callouts",{"title":52,"path":53,"stem":54},"Cross-References","\u002Fdocs\u002Fauthoring\u002Fcross-references","docs\u002F4.authoring\u002F4.cross-references",{"title":56,"path":57,"stem":58},"Deployment","\u002Fdocs\u002Fdeployment","docs\u002F5.deployment",{"title":60,"path":61,"stem":62},"Search","\u002Fdocs\u002Fsearch","docs\u002F6.search",{"title":64,"path":65,"stem":66,"children":67},"Comparisons","\u002Fdocs\u002Fcomparison","docs\u002F7.comparison\u002Findex",[68,69,73,77,81,85,89],{"title":64,"path":65,"stem":66},{"title":70,"path":71,"stem":72},"Docyard vs. Docusaurus","\u002Fdocs\u002Fcomparison\u002Fdocusaurus","docs\u002F7.comparison\u002F1.docusaurus",{"title":74,"path":75,"stem":76},"Docyard vs. Sphinx","\u002Fdocs\u002Fcomparison\u002Fsphinx","docs\u002F7.comparison\u002F2.sphinx",{"title":78,"path":79,"stem":80},"Docyard vs. MkDocs","\u002Fdocs\u002Fcomparison\u002Fmkdocs","docs\u002F7.comparison\u002F3.mkdocs",{"title":82,"path":83,"stem":84},"Docyard vs. VitePress","\u002Fdocs\u002Fcomparison\u002Fvitepress","docs\u002F7.comparison\u002F4.vitepress",{"title":86,"path":87,"stem":88},"Docyard vs. Starlight","\u002Fdocs\u002Fcomparison\u002Fstarlight","docs\u002F7.comparison\u002F5.starlight",{"title":90,"path":91,"stem":92},"Docyard vs. GitBook","\u002Fdocs\u002Fcomparison\u002Fgitbook","docs\u002F7.comparison\u002F6.gitbook",{"title":94,"path":95,"stem":96},"Accessibility","\u002Fdocs\u002Faccessibility","docs\u002F8.accessibility",{"title":98,"path":99,"stem":100},"Docyard","\u002F","index",{"title":102,"path":103,"stem":104},"Notebook Demo","\u002Fnotebook-demo","notebook-demo",{"title":106,"path":107,"stem":108},"References","\u002Freferences","references",[],{"id":111,"title":74,"body":112,"description":479,"extension":480,"meta":481,"navigation":482,"path":75,"seo":483,"stem":76,"__hash__":484},"content\u002Fdocs\u002F7.comparison\u002F2.sphinx.md",{"type":113,"value":114,"toc":469},"minimark",[115,119,135,140,315,319,322,363,375,379,408,412,453,457,463],[116,117,74],"h1",{"id":118},"docyard-vs-sphinx",[120,121,122,129,130,134],"p",{},[123,124,128],"a",{"href":125,"rel":126},"https:\u002F\u002Fwww.sphinx-doc.org\u002F",[127],"nofollow","Sphinx"," is the incumbent for scientific and\ntechnical documentation. The entire scientific-Python ecosystem — NumPy, SciPy,\npandas, Python itself — is built on it. This is the comparison where Docyard's\nedge is ",[131,132,133],"strong",{},"narrowest",", because most of Docyard's scholarly features are things\nSphinx has done well for over a decade.",[136,137,139],"h2",{"id":138},"at-a-glance","At a glance",[141,142,143,158],"table",{},[144,145,146],"thead",{},[147,148,149,154,156],"tr",{},[150,151,153],"th",{"align":152},"left","Dimension",[150,155,98],{"align":152},[150,157,128],{"align":152},[159,160,161,184,210,224,237,260,273,286,302],"tbody",{},[147,162,163,169,181],{},[164,165,166],"td",{"align":152},[131,167,168],{},"Authoring format",[164,170,171,172,176,177,180],{"align":152},"Markdown, Quarto (",[173,174,175],"code",{},".qmd","), Jupyter (",[173,178,179],{},".ipynb",")",[164,182,183],{"align":152},"reStructuredText (MyST adds Markdown)",[147,185,186,191,194],{},[164,187,188],{"align":152},[131,189,190],{},"Cross-references",[164,192,193],{"align":152},"Built-in, numbered, cross-document",[164,195,196,197,99,200,203,204,99,207,180],{"align":152},"Built-in (",[173,198,199],{},"numfig",[173,201,202],{},"numref",", ",[173,205,206],{},":ref:",[173,208,209],{},":doc:",[147,211,212,216,219],{},[164,213,214],{"align":152},[131,215,44],{},[164,217,218],{"align":152},"Built-in",[164,220,196,221,180],{"align":152},[173,222,223],{},"sphinxcontrib-bibtex",[147,225,226,231,234],{},[164,227,228],{"align":152},[131,229,230],{},"Math",[164,232,233],{"align":152},"Built-in (KaTeX)",[164,235,236],{"align":152},"Built-in (MathJax \u002F imgmath)",[147,238,239,244,250],{},[164,240,241],{"align":152},[131,242,243],{},"Python API",[164,245,246,249],{"align":152},[173,247,248],{},"docyard extract"," (griffe)",[164,251,252,255,256,259],{"align":152},[173,253,254],{},"autodoc"," + ",[173,257,258],{},"napoleon"," — the gold standard",[147,261,262,267,270],{},[164,263,264],{"align":152},[131,265,266],{},"Multi-language API",[164,268,269],{"align":152},"Python, Rust, TypeScript, OpenAPI in one CLI",[164,271,272],{"align":152},"Mostly Python; other languages via extensions",[147,274,275,280,283],{},[164,276,277],{"align":152},[131,278,279],{},"Toolchain",[164,281,282],{"align":152},"Nix flake, modern Nuxt frontend",[164,284,285],{"align":152},"Python\u002Fpip, classic themes (or Furo\u002FRTD)",[147,287,288,293,296],{},[164,289,290],{"align":152},[131,291,292],{},"Localization",[164,294,295],{"align":152},"Not built in (roadmap)",[164,297,196,298,301],{"align":152},[173,299,300],{},"gettext"," workflow)",[147,303,304,309,312],{},[164,305,306],{"align":152},[131,307,308],{},"Ecosystem",[164,310,311],{"align":152},"Early-stage",[164,313,314],{"align":152},"Very large, mature extension ecosystem",[136,316,318],{"id":317},"be-honest-sphinx-already-does-the-scholarly-part","Be honest: Sphinx already does the scholarly part",[120,320,321],{},"If you came to Docyard for citations, numbered cross-references, and math, know\nthat Sphinx has all of these natively and battle-tested:",[323,324,325,342,349,354],"ul",{},[326,327,328,330,331,99,333,335,336,338,339,341],"li",{},[131,329,190],{}," — ",[173,332,199],{},[173,334,202],{}," number figures, tables, and listings;\n",[173,337,206],{}," and ",[173,340,209],{}," link anywhere in the project. This is mature.",[326,343,344,330,346,348],{},[131,345,44],{},[173,347,223],{}," renders real BibTeX bibliographies.",[326,350,351,353],{},[131,352,230],{}," — native MathJax.",[326,355,356,330,358,255,360,362],{},[131,357,243],{},[173,359,254],{},[173,361,258],{}," is the reference implementation for\npulling docstrings into docs, and it is deeper than anything Docyard offers\nfor Python alone.",[120,364,365,366,369,370,374],{},"So Docyard does ",[131,367,368],{},"not"," win on \"scholarly features exist.\" It wins, if at all,\non ",[371,372,373],"em",{},"how"," you get them.",[136,376,378],{"id":377},"where-docyard-wins","Where Docyard wins",[323,380,381,387,396,402],{},[326,382,383,386],{},[131,384,385],{},"Markdown and Quarto instead of reStructuredText."," Many authors find reST's\ndirective syntax heavier than Markdown. Docyard's Quarto syntax stays close to\nMarkdown while still giving you citations, callouts, and cross-references.\n(Sphinx can use MyST for Markdown, narrowing this gap.)",[326,388,389,392,393,395],{},[131,390,391],{},"One extractor for several languages."," Sphinx's API story is Python-first;\nRust, TypeScript, and OpenAPI need separate extensions or external tools.\nDocyard's single ",[173,394,248],{}," CLI covers Python, Rust, TypeScript, and\nOpenAPI with one consistent renderer — useful for polyglot repos.",[326,397,398,401],{},[131,399,400],{},"Nix-native reproducibility."," Docyard is a flake input with a pinned\ntoolchain; in managed mode authors touch only content files. Sphinx leaves\nPython environment management to you.",[326,403,404,407],{},[131,405,406],{},"A modern frontend out of the box."," Docyard ships a current Nuxt theme with\nbuilt-in search backends and OG-image generation. Sphinx's default theme is\ndated (most projects adopt Furo or the Read the Docs theme).",[136,409,411],{"id":410},"where-sphinx-wins","Where Sphinx wins",[323,413,414,420,428,438,444],{},[326,415,416,419],{},[131,417,418],{},"Maturity and trust."," Two decades of use across the scientific world. Edge\ncases are solved; the behavior is predictable.",[326,421,422,427],{},[131,423,424,426],{},[173,425,254],{}," depth."," The deepest Python docstring extraction available.",[326,429,430,433,434,437],{},[131,431,432],{},"Extension ecosystem."," Hundreds of mature extensions\n(",[173,435,436],{},"sphinxcontrib-*",", diagrams, domains for other languages, …).",[326,439,440,443],{},[131,441,442],{},"reStructuredText power."," Directives, roles, and domains give fine-grained\nsemantic markup that Markdown does not natively express.",[326,445,446,449,450,452],{},[131,447,448],{},"Built-in localization."," A mature ",[173,451,300],{},"-based translation workflow.\nDocyard has none yet.",[136,454,456],{"id":455},"decision-guide","Decision guide",[120,458,459,462],{},[131,460,461],{},"Choose Docyard if"," you want Markdown\u002FQuarto authoring over reST, need\nmulti-language (not just Python) API reference from one tool, already use Nix,\nand want a modern frontend without assembling a theme.",[120,464,465,468],{},[131,466,467],{},"Choose Sphinx if"," you are a Python project that wants the deepest, most\ntrusted API extraction, you need its huge extension ecosystem, you need mature\nlocalization, or reStructuredText's semantic power matters to you.",{"title":470,"searchDepth":471,"depth":471,"links":472},"",3,[473,475,476,477,478],{"id":138,"depth":474,"text":139},2,{"id":317,"depth":474,"text":318},{"id":377,"depth":474,"text":378},{"id":410,"depth":474,"text":411},{"id":455,"depth":474,"text":456},"An honest comparison of Docyard and Sphinx — the scientific-Python documentation incumbent.","md",{},true,{"title":74,"description":479},"O2qFMXU8wiYpihGbVkHEIRtqdDhSrkbNiUxOWU52ot8",{"fig-authoring-example":486,"tbl-authoring-demo":489,"eq-authoring-energy":491,"fig-pipeline":493,"tbl-solvers":494,"eq-loss":495},{"kind":487,"number":488,"path":11},"fig",1,{"kind":490,"number":488,"path":11},"tbl",{"kind":492,"number":488,"path":11},"eq",{"kind":487,"number":488,"path":53},{"kind":490,"number":488,"path":53},{"kind":492,"number":488,"path":53},1784218152316]