| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /:user_id/:repository |
| route-controller | files |
| route-action | disambiguate |
| fetch-nonce | v2:b987e25d-ed76-e1b0-2dd7-1587eba50a4a |
| current-catalog-service-hash | f3abb0cc802f3d7b95fc8762b94bdcb13bf39634c40c357301c4aa1d67a256fb |
| request-id | DF9A:4D728:310F65C:40B7BBC:6B002BF8 |
| html-safe-nonce | 4861ba435843c4ab53cde5ff4781af7853645ab80db1c63fd92d4ad7c5d19702 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJERjlBOjRENzI4OjMxMEY2NUM6NDBCN0JCQzo2QjAwMkJGOCIsInZpc2l0b3JfaWQiOiI2MzMxMjQyNDMxMzQxNjY5MzY5IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 1525c6eea1af69fdb8b4ef2d1929f3b1b1ddd07eb84086917a6f042ac0f9f003 |
| hovercard-subject-tag | repository:84005525 |
| github-keyboard-shortcuts | repository,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | // |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/timstaley/sphinx-example |
| twitter:image | https://opengraph.githubassets.com/d77b770644ddd9f1255a1e65467c4f9d9d5b177af3066a9559e120853634edb1/timstaley/sphinx-example |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/d77b770644ddd9f1255a1e65467c4f9d9d5b177af3066a9559e120853634edb1/timstaley/sphinx-example |
| og:image:alt | A mini-tutorial / cheatsheet / link-collection to get you started documenting Python code using Sphinx. - timstaley/sphinx-example |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 7d0829bbde9e48b2486cb5dd6d147896eb01d32134627091f818958a935ef3f0 |
| turbo-cache-control | no-cache |
| go-import | github.com/timstaley/sphinx-example git https://github.com/timstaley/sphinx-example.git |
| octolytics-dimension-user_id | 1352905 |
| octolytics-dimension-user_login | timstaley |
| octolytics-dimension-repository_id | 84005525 |
| octolytics-dimension-repository_nwo | timstaley/sphinx-example |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 84005525 |
| octolytics-dimension-repository_network_root_nwo | timstaley/sphinx-example |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | f3f3a43ca095cdea3abbb394112e971f9fdb94fa |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| Skip to content | https://github.com/timstaley/sphinx-example#start-of-content |
| https://github.com/ |
| Sign in | https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Ftimstaley%2Fsphinx-example |
| GitHubRepository hosting, code review, and collaboration | https://github.com/platform |
| CopilotAI coding agent for tasks, projects, and automated work | https://github.com/features/copilot |
| ActionsCI/CD and automation | https://github.com/features/actions |
| Code QualityQuality analysis, fixes, and enforcement | https://github.com/features/code-quality |
| CodespacesCloud development environments | https://github.com/features/codespaces |
| Code SecurityVulnerability detection and remediation | https://github.com/security/advanced-security/code-security |
| Secret ProtectionSecret scanning and leak prevention | https://github.com/security/advanced-security/secret-protection |
| All Features | https://github.com/features |
| Documentation | https://docs.github.com/en |
| Training | https://learn.github.com/skills |
| Certifications | https://learn.github.com/credentials |
| Build with Copilot | https://github.com/features/ai |
| Customize Copilot | https://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview |
| Integrations | https://github.com/marketplace |
| Trending repos | https://github.com/trending |
| GitHub Sponsors | https://github.com/open-source/sponsors |
| Developer articles | https://github.com/resources/articles |
| ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place. | https://github.blog/changelog/ |
| Enterprises | https://github.com/enterprise |
| Team | https://github.com/team |
| Startups | https://github.com/enterprise/startups |
| Nonprofits | https://github.com/solutions/industry/nonprofits |
| Healthcare | https://github.com/solutions/industry/healthcare |
| Financial services | https://github.com/solutions/industry/financial-services |
| Manufacturing | https://github.com/solutions/industry/manufacturing |
| Government | https://github.com/solutions/industry/government |
| See all industries | https://github.com/solutions/industry |
| Why GitHub | https://github.com/why-github |
| Customer Stories | https://github.com/customer-stories |
| Business insights | https://github.com/solutions/executive-insights |
| Trust Center | https://github.com/trust-center |
| GitHub Advanced SecurityEnterprise-grade code security | https://github.com/security/advanced-security |
| Copilot for businessEnterprise-grade AI features | https://github.com/features/copilot/copilot-business |
| Premium SupportEnterprise-grade 24/7 support | https://github.com/enterprise/premium-support |
| Documentation | https://docs.github.com/en |
| Resource center | https://github.com/resources |
| Blog | https://github.blog/ |
| Events & webinars | https://github.com/resources/events |
| Community Forum | https://github.com/orgs/community/discussions |
| Customer Stories | https://github.com/customer-stories |
| Integrations | https://github.com/marketplace |
| Customer support | https://help.github.com/ |
| Training | https://learn.github.com/skills |
| GitHub Status | https://www.githubstatus.com/ |
| About | https://github.com/about |
| Partners | https://github.com/partners |
| Changelog | https://github.blog/changelog/ |
| GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub. | https://githubuniverse.com/ |
| Pricing | https://github.com/pricing |
| Sign in | https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Ftimstaley%2Fsphinx-example |
| Sign up | https://github.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 |
| Reload | https://github.com/timstaley/sphinx-example |
| Reload | https://github.com/timstaley/sphinx-example |
| Reload | https://github.com/timstaley/sphinx-example |
| timstaley | https://github.com/timstaley |
| sphinx-example | https://github.com/timstaley/sphinx-example |
| Code | https://github.com/timstaley/sphinx-example |
| Issues | https://github.com/timstaley/sphinx-example/issues |
| Pull requests | https://github.com/timstaley/sphinx-example/pulls |
| Actions | https://github.com/timstaley/sphinx-example/actions |
| Projects | https://github.com/timstaley/sphinx-example/projects |
| Security and quality | https://github.com/timstaley/sphinx-example/security |
| Insights | https://github.com/timstaley/sphinx-example/pulse |
| https://github.com/timstaley/sphinx-example |
| sphinx-example | https://github.com/timstaley/sphinx-example |
| Notifications | https://github.com/login?return_to=%2Ftimstaley%2Fsphinx-example |
| Fork51 (51) | https://github.com/login?return_to=%2Ftimstaley%2Fsphinx-example |
| Star34 (34) | https://github.com/login?return_to=%2Ftimstaley%2Fsphinx-example |
| cheatsheet | https://github.com/topics/cheatsheet |
| documentation | https://github.com/topics/documentation |
| python | https://github.com/topics/python |
| sphinx | https://github.com/topics/sphinx |
| tutorial | https://github.com/topics/tutorial |
| Readme | https://github.com/timstaley/sphinx-example#readme-ov-file |
| Activity | https://github.com/timstaley/sphinx-example/activity |
| 51 forks | https://github.com/timstaley/sphinx-example/forks |
| Report repository | https://github.com/contact/report-content?content_url=https%3A%2F%2Fgithub.com%2Ftimstaley%2Fsphinx-example&report=timstaley+%28user%29 |
| Branches | https://github.com/timstaley/sphinx-example/branches |
| Tags | https://github.com/timstaley/sphinx-example/tags |
| https://github.com/timstaley/sphinx-example/branches |
| https://github.com/timstaley/sphinx-example/tags |
| 5 Commits | https://github.com/timstaley/sphinx-example/commits/master/ |
| https://github.com/timstaley/sphinx-example/commits/master/ |
| docs | https://github.com/timstaley/sphinx-example/tree/master/docs |
| docs | https://github.com/timstaley/sphinx-example/tree/master/docs |
| examplecode | https://github.com/timstaley/sphinx-example/tree/master/examplecode |
| examplecode | https://github.com/timstaley/sphinx-example/tree/master/examplecode |
| README.rst | https://github.com/timstaley/sphinx-example/blob/master/README.rst |
| README.rst | https://github.com/timstaley/sphinx-example/blob/master/README.rst |
| README | https://github.com/timstaley/sphinx-example |
| https://github.com/timstaley/sphinx-example#sphinx-example |
| Sphinx | http://www.sphinx-doc.org/ |
| Oxford Astrophysics | http://www2.physics.ox.ac.uk/research/astrophysics |
| https://github.com/timstaley/sphinx-example#sphinx-and-rst---what-are-they |
| Sphinx | http://www.sphinx-doc.org/ |
| MarkDown | http://daringfireball.net/projects/markdown/syntax |
| hyperlink | https://www.youtube.com/watch?v=dQw4w9WgXcQ |
| directives | http://www.sphinx-doc.org/en/1.5.1/glossary.html#term-directive |
| roles | http://www.sphinx-doc.org/en/1.5.1/glossary.html#term-role |
| options | http://www.sphinx-doc.org/en/1.5.1/glossary.html#term-directive |
| Breathe | http://breathe.readthedocs.io/ |
| https://github.com/timstaley/sphinx-example#super-brief-overview |
| [*] | https://github.com/timstaley/sphinx-example#id2 |
| autodoc | http://www.sphinx-doc.org/en/stable/ext/autodoc.html |
| Sphinx-Napoleon | http://sphinxcontrib-napoleon.readthedocs.io/en/latest/ |
| ReadTheDocs | https://docs.readthedocs.io/ |
| [*] | https://github.com/timstaley/sphinx-example#id1 |
| https://github.com/timstaley/sphinx-example#rst-links-and-references |
| https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst | https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst |
| http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html | http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html |
| http://rst.ninjs.org/ | http://rst.ninjs.org/ |
| http://dillinger.io/ | http://dillinger.io/ |
| https://github.com/timstaley/sphinx-example#sphinx-links |
| http://www.sphinx-doc.org/en/stable/tutorial.html | http://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.html | http://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html |
| argparse | https://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/ |
| cheatsheet | https://github.com/topics/cheatsheet |
| documentation | https://github.com/topics/documentation |
| python | https://github.com/topics/python |
| sphinx | https://github.com/topics/sphinx |
| tutorial | https://github.com/topics/tutorial |
| Readme | https://github.com/timstaley/sphinx-example#readme-ov-file |
| Activity | https://github.com/timstaley/sphinx-example/activity |
| 51 forks | https://github.com/timstaley/sphinx-example/forks |
| Report repository | https://github.com/contact/report-content?content_url=https%3A%2F%2Fgithub.com%2Ftimstaley%2Fsphinx-example&report=timstaley+%28user%29 |
|
| https://github.com |
| Terms | https://docs.github.com/site-policy/github-terms/github-terms-of-service |
| Privacy | https://docs.github.com/site-policy/privacy-policies/github-privacy-statement |
| Security | https://github.com/security |
| Status | https://www.githubstatus.com/ |
| Community | https://github.community/ |
| Docs | https://docs.github.com/ |
| Contact | https://support.github.com?tags=dotcom-footer |