Skip to content

Conversation

krishnajs
Copy link
Contributor

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:

  • Completely rewrote 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.
  • Updated docs/deployment_guide/index.rst, docs/developer_guide/index.rst, and docs/release_notes/index.rst to improve section overviews, add navigation captions, and use toctree for better content organization. [1] [2] [3]
  • Added section captions and maxdepth to docs/api/index.rst for clearer API reference navigation.

Sphinx Configuration and Import Handling:

  • Refactored docs/conf.py to import configuration variables directly from docconf.docconf instead of using the docconf. prefix, and updated variable assignments for local builds. [1] [2]
  • Updated docconf/docconf/__init__.py to expose all config variables for easier imports in Sphinx conf.py.

Custom Styles and Interactivity:

  • Added a new custom_sitemap.css file with styles for an interactive sitemap, and a custom_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

  • Tests passed
  • Documentation updated

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.
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