René's URL Explorer Experiment


Title: GitHub - timstaley/sphinx-example: A mini-tutorial / cheatsheet / link-collection to get you started documenting Python code using Sphinx.

Open Graph Title: GitHub - timstaley/sphinx-example: A mini-tutorial / cheatsheet / link-collection to get you started documenting Python code using Sphinx.

X Title: GitHub - timstaley/sphinx-example: A mini-tutorial / cheatsheet / link-collection to get you started documenting Python code using Sphinx.

Description: A mini-tutorial / cheatsheet / link-collection to get you started documenting Python code using Sphinx. - timstaley/sphinx-example

Open Graph Description: A mini-tutorial / cheatsheet / link-collection to get you started documenting Python code using Sphinx. - timstaley/sphinx-example

X Description: A mini-tutorial / cheatsheet / link-collection to get you started documenting Python code using Sphinx. - timstaley/sphinx-example

Opengraph URL: https://github.com/timstaley/sphinx-example

X: @github

direct link

Domain: patch-diff.githubusercontent.com

route-pattern/:user_id/:repository
route-controllerfiles
route-actiondisambiguate
fetch-noncev2:fe5875ff-17a2-1055-0a4e-b4e569a3aed5
current-catalog-service-hashf3abb0cc802f3d7b95fc8762b94bdcb13bf39634c40c357301c4aa1d67a256fb
request-idA20E:F30B1:33ADA4:427E8F:697DCD61
html-safe-noncec33a1902aa569c09f7d41c6d97116d7899a51b2a1b263e12a1c853bac3fe867b
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBMjBFOkYzMEIxOjMzQURBNDo0MjdFOEY6Njk3RENENjEiLCJ2aXNpdG9yX2lkIjoiNTI0MTQzNDgyMjU4NDE1OTU4NSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmaca77a67935376209777497ddf2d33b98d6caa9c80ca110ebb101782eb73fc9ec2
hovercard-subject-tagrepository:84005525
github-keyboard-shortcutsrepository,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location//
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/timstaley/sphinx-example
twitter:imagehttps://opengraph.githubassets.com/207346caec36c7173e89c1f645c7b76e77a04f4a6c552bf8c28254c14adcf958/timstaley/sphinx-example
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/207346caec36c7173e89c1f645c7b76e77a04f4a6c552bf8c28254c14adcf958/timstaley/sphinx-example
og:image:altA mini-tutorial / cheatsheet / link-collection to get you started documenting Python code using Sphinx. - timstaley/sphinx-example
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None60279d4097367e16897439d16d6bbe4180663db828c666eeed2656988ffe59f6
turbo-cache-controlno-preview
go-importgithub.com/timstaley/sphinx-example git https://github.com/timstaley/sphinx-example.git
octolytics-dimension-user_id1352905
octolytics-dimension-user_logintimstaley
octolytics-dimension-repository_id84005525
octolytics-dimension-repository_nwotimstaley/sphinx-example
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id84005525
octolytics-dimension-repository_network_root_nwotimstaley/sphinx-example
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release7c85641c598ad130c74f7bcc27f58575cac69551
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://patch-diff.githubusercontent.com/timstaley/sphinx-example#start-of-content
https://patch-diff.githubusercontent.com/
Sign in https://patch-diff.githubusercontent.com/login?return_to=https%3A%2F%2Fgithub.com%2Ftimstaley%2Fsphinx-example
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub SparkBuild and deploy intelligent appshttps://github.com/features/spark
GitHub ModelsManage and compare promptshttps://github.com/features/models
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://patch-diff.githubusercontent.com/login?return_to=https%3A%2F%2Fgithub.com%2Ftimstaley%2Fsphinx-example
Sign up https://patch-diff.githubusercontent.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E&source=header-repo&source_repo=timstaley%2Fsphinx-example
Reloadhttps://patch-diff.githubusercontent.com/timstaley/sphinx-example
Reloadhttps://patch-diff.githubusercontent.com/timstaley/sphinx-example
Reloadhttps://patch-diff.githubusercontent.com/timstaley/sphinx-example
timstaley https://patch-diff.githubusercontent.com/timstaley
sphinx-examplehttps://patch-diff.githubusercontent.com/timstaley/sphinx-example
Notifications https://patch-diff.githubusercontent.com/login?return_to=%2Ftimstaley%2Fsphinx-example
Fork 51 https://patch-diff.githubusercontent.com/login?return_to=%2Ftimstaley%2Fsphinx-example
Star 33 https://patch-diff.githubusercontent.com/login?return_to=%2Ftimstaley%2Fsphinx-example
33 stars https://patch-diff.githubusercontent.com/timstaley/sphinx-example/stargazers
51 forks https://patch-diff.githubusercontent.com/timstaley/sphinx-example/forks
Branches https://patch-diff.githubusercontent.com/timstaley/sphinx-example/branches
Tags https://patch-diff.githubusercontent.com/timstaley/sphinx-example/tags
Activity https://patch-diff.githubusercontent.com/timstaley/sphinx-example/activity
Star https://patch-diff.githubusercontent.com/login?return_to=%2Ftimstaley%2Fsphinx-example
Notifications https://patch-diff.githubusercontent.com/login?return_to=%2Ftimstaley%2Fsphinx-example
Code https://patch-diff.githubusercontent.com/timstaley/sphinx-example
Issues 0 https://patch-diff.githubusercontent.com/timstaley/sphinx-example/issues
Pull requests 0 https://patch-diff.githubusercontent.com/timstaley/sphinx-example/pulls
Actions https://patch-diff.githubusercontent.com/timstaley/sphinx-example/actions
Projects 0 https://patch-diff.githubusercontent.com/timstaley/sphinx-example/projects
Security 0 https://patch-diff.githubusercontent.com/timstaley/sphinx-example/security
Insights https://patch-diff.githubusercontent.com/timstaley/sphinx-example/pulse
Code https://patch-diff.githubusercontent.com/timstaley/sphinx-example
Issues https://patch-diff.githubusercontent.com/timstaley/sphinx-example/issues
Pull requests https://patch-diff.githubusercontent.com/timstaley/sphinx-example/pulls
Actions https://patch-diff.githubusercontent.com/timstaley/sphinx-example/actions
Projects https://patch-diff.githubusercontent.com/timstaley/sphinx-example/projects
Security https://patch-diff.githubusercontent.com/timstaley/sphinx-example/security
Insights https://patch-diff.githubusercontent.com/timstaley/sphinx-example/pulse
Brancheshttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/branches
Tagshttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/tags
https://patch-diff.githubusercontent.com/timstaley/sphinx-example/branches
https://patch-diff.githubusercontent.com/timstaley/sphinx-example/tags
5 Commitshttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/commits/master/
https://patch-diff.githubusercontent.com/timstaley/sphinx-example/commits/master/
docshttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/tree/master/docs
docshttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/tree/master/docs
examplecodehttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/tree/master/examplecode
examplecodehttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/tree/master/examplecode
README.rsthttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/blob/master/README.rst
README.rsthttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/blob/master/README.rst
READMEhttps://patch-diff.githubusercontent.com/timstaley/sphinx-example
https://patch-diff.githubusercontent.com/timstaley/sphinx-example#sphinx-example
Sphinxhttp://www.sphinx-doc.org/
Oxford Astrophysicshttp://www2.physics.ox.ac.uk/research/astrophysics
https://patch-diff.githubusercontent.com/timstaley/sphinx-example#sphinx-and-rst---what-are-they
Sphinxhttp://www.sphinx-doc.org/
MarkDownhttp://daringfireball.net/projects/markdown/syntax
hyperlinkhttps://www.youtube.com/watch?v=dQw4w9WgXcQ
directiveshttp://www.sphinx-doc.org/en/1.5.1/glossary.html#term-directive
roleshttp://www.sphinx-doc.org/en/1.5.1/glossary.html#term-role
optionshttp://www.sphinx-doc.org/en/1.5.1/glossary.html#term-directive
Breathehttp://breathe.readthedocs.io/
https://patch-diff.githubusercontent.com/timstaley/sphinx-example#super-brief-overview
[*]https://patch-diff.githubusercontent.com/timstaley/sphinx-example#id2
autodochttp://www.sphinx-doc.org/en/stable/ext/autodoc.html
Sphinx-Napoleonhttp://sphinxcontrib-napoleon.readthedocs.io/en/latest/
ReadTheDocshttps://docs.readthedocs.io/
[*]https://patch-diff.githubusercontent.com/timstaley/sphinx-example#id1
https://patch-diff.githubusercontent.com/timstaley/sphinx-example#rst-links-and-references
https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rsthttps://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.htmlhttp://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
http://rst.ninjs.org/http://rst.ninjs.org/
http://dillinger.io/http://dillinger.io/
https://patch-diff.githubusercontent.com/timstaley/sphinx-example#sphinx-links
http://www.sphinx-doc.org/en/stable/tutorial.htmlhttp://www.sphinx-doc.org/en/stable/tutorial.html
https://samnicholls.net/2016/06/15/how-to-sphinx-readthedocs/https://samnicholls.net/2016/06/15/how-to-sphinx-readthedocs/
http://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.htmlhttp://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html
argparsehttps://docs.python.org/3/library/argparse.html
https://sphinx-argparse.readthedocs.io/https://sphinx-argparse.readthedocs.io/
https://nbsphinx.readthedocs.io/https://nbsphinx.readthedocs.io/
https://docs.readthedocs.io/https://docs.readthedocs.io/
http://voevent-parse.readthedocs.io/http://voevent-parse.readthedocs.io/
python https://patch-diff.githubusercontent.com/topics/python
documentation https://patch-diff.githubusercontent.com/topics/documentation
tutorial https://patch-diff.githubusercontent.com/topics/tutorial
sphinx https://patch-diff.githubusercontent.com/topics/sphinx
cheatsheet https://patch-diff.githubusercontent.com/topics/cheatsheet
Readme https://patch-diff.githubusercontent.com/timstaley/sphinx-example#readme-ov-file
Please reload this pagehttps://patch-diff.githubusercontent.com/timstaley/sphinx-example
Activityhttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/activity
33 starshttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/stargazers
2 watchinghttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/watchers
51 forkshttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/forks
Report repository https://patch-diff.githubusercontent.com/contact/report-content?content_url=https%3A%2F%2Fgithub.com%2Ftimstaley%2Fsphinx-example&report=timstaley+%28user%29
Releaseshttps://patch-diff.githubusercontent.com/timstaley/sphinx-example/releases
Packages 0https://patch-diff.githubusercontent.com/users/timstaley/packages?repo_name=sphinx-example
Python 100.0% https://patch-diff.githubusercontent.com/timstaley/sphinx-example/search?l=python
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.