Update documentation to use cosmic theme and improve structure#143
Draft
Copilot wants to merge 3 commits intotfcollins/microblaze-testingfrom
Draft
Update documentation to use cosmic theme and improve structure#143Copilot wants to merge 3 commits intotfcollins/microblaze-testingfrom
Copilot wants to merge 3 commits intotfcollins/microblaze-testingfrom
Conversation
Co-authored-by: tfcollins <854904+tfcollins@users.noreply.github.com>
Co-authored-by: tfcollins <854904+tfcollins@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation to match style of pyadi-iio
Update documentation to use cosmic theme and improve structure
Oct 19, 2025
gastmaier
reviewed
Oct 27, 2025
| sphinx-rtd-theme | ||
| graphviz | ||
| myst-parser No newline at end of file | ||
| sphinx>=5.0 |
Contributor
There was a problem hiding this comment.
the sphinx extensions + python version already bounds the sphinx version, setting an arbitrary is useless and only causes unnecessary install lock-ups.
it only makes sense to bound for actual python packages, not collateral such as docs.
| "adi_doctools", | ||
| ] | ||
|
|
||
| needs_extensions = {"adi_doctools": "0.4.21"} |
Contributor
There was a problem hiding this comment.
garbage version lock. the doc does not depend in any particular version
| # a list of builtin themes. | ||
| # | ||
| html_theme = "sphinx_rtd_theme" | ||
| html_theme = "cosmic" |
Contributor
There was a problem hiding this comment.
Suggested change
| html_theme = "cosmic" | |
| html_theme = "harmonic" |
Comment on lines
+81
to
+83
| html_css_files = [ | ||
| "css/custom.css", | ||
| ] |
Comment on lines
+1
to
+3
| /* Custom CSS for Nebula documentation */ | ||
|
|
||
| /* Placeholder for any custom styling */ |
Comment on lines
+6
to
+7
| Nebula: Embedded Development Tools | ||
| ===================================================================== |
| graphviz | ||
| myst-parser No newline at end of file | ||
| sphinx>=5.0 | ||
| myst-parser |
Contributor
There was a problem hiding this comment.
The doc is not in markdown, remove myst-parser
| "sphinx.ext.githubpages", | ||
| "sphinx_rtd_theme", | ||
| "sphinx.ext.graphviz", | ||
| "myst_parser", |
tfcollins
force-pushed
the
tfcollins/microblaze-testing
branch
from
5de87a6 to
2ca6f90
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR modernizes the Nebula documentation by adopting the cosmic theme from adi-doctools (same theme used by pyadi-iio) and significantly improves the documentation structure to better communicate the tool's scope and capabilities.
Overview
The previous documentation used the basic sphinx-rtd-theme and lacked clear organization for CLI and API references. Users had difficulty understanding what Nebula does and how to use it effectively. This update addresses these issues with a professional theme and comprehensive structural improvements.
Key Changes
Theme Update
sphinx-rtd-themewith thecosmictheme fromadi-doctoolsDocumentation Structure
Created a clear, organized structure with distinct sections:
Homepage Enhancements:
New API Reference Organization:
doc/source/core/api.rstorganizing modules into logical categories:Clear Navigation:
Visual Improvements
Homepage:
CLI Reference:
API Reference:
Technical Details
requirements_doc.txtto include adi-doctools packageconf.pywith proper cosmic theme configurationreadthedocs.ymlto install documentation requirements_static/css/custom.cssfor future customization needsBenefits
Fixes #[issue-number]
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.