Skip to content
Navigation Menu
Sign in
Products
Platform
GitHub
Repository hosting, code review, and collaboration
Copilot
AI coding agent for tasks, projects and automated work
Build & Ship
Actions
CI/CD and automation
Code Quality
Quality analysis, fixes, and enforcement
Codespaces
Cloud development environments
Secure
Code Security
Vulnerability detection and remediation
Secret Protection
Secret scanning and leak prevention
All Features
Developers
Learn
Documentation
Training
Certifications
Build
Build with Copilot
Customize Copilot
Integrations
Explore
Trending repos
GitHub Sponsors
Events
Changelog
Changelog
Your source for the latest features, improvements, and fixes across GitHub products, all in one place.
Businesses
By Stage
Enterprises
Team
Startups
Nonprofits
By Industry
Healthcare
Financial services
Manufacturing
Government
See all industries
Evaluate GitHub
Why GitHub
Customer Stories
Business insights
Trust Center
Add-ons
GitHub Advanced Security
Enterprise-grade code security
Copilot for business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Resources
Learn & Connect
Documentation
Resource center
Blog
Events & webinars
Community Forum
Customer Stories
Integrations
Support
Customer support
Training
GitHub Status
Company
About
Partners
Changelog
GitHub Universe
GitHub Universe
The event for developers, by developers — talks, workshops, and what’s next for GitHub.
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
gregreen
dustmaps
Repository navigation
Code
Issues
6
(6)
Pull requests
3
(3)
Actions
Projects
Security and quality
Insights
More
items
Files
Expand file tree
master
Breadcrumbs
dustmaps
/
.readthedocs.yaml
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
35 lines (30 loc) · 1 KB
master
Breadcrumbs
dustmaps
/
.readthedocs.yaml
Copy path
Top
File metadata and controls
Code
Blame
35 lines (30 loc) · 1 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
#
Read the Docs configuration file for Sphinx projects
#
See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
#
Required
version
:
2
#
Set the OS, Python version and other tools you might need
build
:
os
:
ubuntu-22.04
tools
:
python
:
"
3.12
"
#
You can also specify other tool versions:
#
nodejs: "20"
#
rust: "1.70"
#
golang: "1.20"
#
Build documentation in the "docs/" directory with Sphinx
sphinx
:
configuration
:
docs/conf.py
#
You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
#
builder: "dirhtml"
#
Fail on all warnings to avoid broken references
#
fail_on_warning: true
#
Optionally build your docs in additional formats such as PDF and ePub
#
formats:
#
- pdf
#
- epub
#
Optional but recommended, declare the Python requirements required
#
to build your documentation
#
See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python
:
install
:
-
requirements
:
docs/requirements.txt
You can’t perform that action at this time.