Revamp documentation structure and navigation #108
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.
Reorganized and streamlined Sphinx documentation with improved navigation, concise section overviews, and a new interactive sitemap. Updated index and section files for clarity, added custom sitemap CSS/JS, and refactored docconf imports for maintainability. Enhanced user, developer, and deployment guides for better usability and discoverability.
PR Description
This pull request makes significant improvements to the Sphinx documentation structure, navigation, and configuration for the Edge Orchestrator project. The changes streamline the documentation's main pages for easier navigation, introduce new custom styles and interactivity, and simplify the configuration import process for Sphinx builds.
Changes
Documentation Structure and Navigation Improvements:
docs/index.rst
to provide a more concise and navigable landing page, using toctree-based quick links and reorganized sections for deployment, user, and developer guides.docs/deployment_guide/index.rst
,docs/developer_guide/index.rst
, anddocs/release_notes/index.rst
to improve section overviews, add navigation captions, and use toctree for better content organization. [1] [2] [3]docs/api/index.rst
for clearer API reference navigation.Sphinx Configuration and Import Handling:
docs/conf.py
to import configuration variables directly fromdocconf.docconf
instead of using thedocconf.
prefix, and updated variable assignments for local builds. [1] [2]docconf/docconf/__init__.py
to expose all config variables for easier imports in Sphinxconf.py
.Custom Styles and Interactivity:
custom_sitemap.css
file with styles for an interactive sitemap, and acustom_sitemap.js
file to enable collapsible sitemap sections on the documentation site. [1] [2]Additional Information
Include any additional information, such as how to test your changes.
Checklist