Skip to content

Commit 758b18b

Browse files
dshkolclaude
andcommitted
Add prominent documentation links to README and package
## Changes ### README.md - Added new "Documentation" section after API Key setup - Includes direct links to: - Main documentation site (pycancensus.readthedocs.io) - Getting Started tutorial - Working with Geographic Data tutorial - Example Gallery - API Reference - R to Python Migration Guide - Makes documentation discoverable before Quick Start examples ### pycancensus/__init__.py - Added documentation URL to package docstring - Appears when users do `help(pycancensus)` in Python ### Note - pyproject.toml already had Documentation URL in project.urls - Documentation badge already present in README badges section ## Impact Users can now easily find comprehensive documentation from: - GitHub README (new prominent section) - Python help() command - PyPI package page (via pyproject.toml) - README badge 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 513af55 commit 758b18b

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,17 @@ import pycancensus as pc
8585
pc.set_api_key("your_api_key_here")
8686
```
8787

88+
## Documentation
89+
90+
**Full documentation is available at [pycancensus.readthedocs.io](https://pycancensus.readthedocs.io/)**
91+
92+
The documentation includes:
93+
- **[Getting Started Tutorial](https://pycancensus.readthedocs.io/en/latest/tutorials/getting_started.html)** - Learn the basics
94+
- **[Working with Geographic Data](https://pycancensus.readthedocs.io/en/latest/tutorials/working_with_geometry.html)** - Maps and spatial analysis
95+
- **[Example Gallery](https://pycancensus.readthedocs.io/en/latest/auto_examples/index.html)** - Real-world usage examples
96+
- **[API Reference](https://pycancensus.readthedocs.io/en/latest/api/index.html)** - Complete function documentation
97+
- **[R to Python Migration Guide](https://pycancensus.readthedocs.io/en/latest/migration.html)** - For R cancensus users
98+
8899
## Quick Start
89100

90101
```python

pycancensus/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
44
This package provides integrated, convenient, and uniform access to Canadian
55
Census data and geography retrieved using the CensusMapper API.
6+
7+
Documentation: https://pycancensus.readthedocs.io/
68
"""
79

810
__version__ = "0.1.0"

0 commit comments

Comments
 (0)