Skip to content

docs: documentation overhaul — theme, content, and terminology updates#383

Merged
ruck314 merged 7 commits into
mainfrom
doc-dev
Mar 29, 2026
Merged

docs: documentation overhaul — theme, content, and terminology updates#383
ruck314 merged 7 commits into
mainfrom
doc-dev

Conversation

@ruck314
Copy link
Copy Markdown
Contributor

@ruck314 ruck314 commented Mar 29, 2026

Summary

  • Theme: Switch Sphinx theme from Furo to sphinx_rtd_theme to match the rogue documentation site; adds titles_only and navigation_depth options. Eliminates Furo-specific TOC errors in reference pages as a side-effect.
  • Metadata: Update copyright year to 2026; replace jsmith placeholder username with smith across all .rst source files.
  • Build pipeline: Add make gui interactive build section explaining use cases (exploration, synth review, XSIM, timing debug); rename "Partial Flows" section to "Dynamic Function eXchange (DFX) and Partial Build Flows" per AMD UG909 terminology.
  • Recursion diagram: Rework the ::DIR_PATH two-level recursion example with explicit [SAVE]/[SET]/[RESTORE] annotations and a "What to notice" callout.
  • ASIC how-tos: Add "Top-Level ruckus.tcl Structure" section to both Cadence Genus and Synopsys DC how-to guides explaining the manual GenBuildString / AnalyzeSrcFileLists calls required (unlike the Vivado flow).

Files changed

  • docs/conf.py — theme, theme options, copyright
  • docs/requirements.txt — furo → sphinx-rtd-theme, remove sphinx-autodoc-typehints
  • docs/explanation/build_pipeline.rst — make gui section, DFX rename
  • docs/explanation/ruckus_tcl_model.rst — annotated recursion diagram
  • docs/explanation/output_artifacts.rst — jsmith → smith
  • docs/tutorial/first_vivado_build.rst — jsmith → smith
  • docs/how-to/cadence_genus.rst — ruckus.tcl structure section
  • docs/how-to/synopsys_dc.rst — ruckus.tcl structure section

@ruck314 ruck314 merged commit f0d06b5 into main Mar 29, 2026
4 checks passed
@ruck314 ruck314 deleted the doc-dev branch March 29, 2026 03:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant