Add type hints and set up Sphinx documentation#61
Merged
Conversation
Type Hints: - Added type hints to src/dvoacap/__init__.py - get_phase_status() -> Dict[str, str] - get_version_info() -> Dict[str, Any] - Fixed path_geometry.py to use Tuple from typing for Python 3.8 compatibility - Changed tuple[float, float] to Tuple[float, float] - Added Tuple import from typing module Sphinx Documentation: - Created docs/source/ directory structure - Added docs/source/conf.py with comprehensive Sphinx configuration - Configured autodoc, napoleon, viewcode, intersphinx extensions - Set up Google/NumPy docstring support - Configured alabaster theme - Created documentation pages: - index.rst: Main documentation page - api.rst: Complete API reference for all modules - overview.rst: Project overview and architecture - installation.rst: Installation instructions - quickstart.rst: Quick start guide with examples - examples.rst: Detailed code examples - Added docs/Makefile for building documentation - Added docs/README.md explaining documentation setup - Created _static/ and _templates/ directories for Sphinx All changes maintain Python 3.8+ compatibility and follow best practices.
Document planning notes from VOACAP manual review: - Target DXCC selection and Maidenhead grid support - Greyline propagation visualization - Antenna selection including DX Commander - Propagation and reliability chart tabs - MUF analysis tools - Coverage area maps with smoothing - Mini planner functionality - Data presentation philosophy
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
2 participants
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.
No description provided.