René's URL Explorer Experiment


Title: Change documentation generator to Sphinx by pradyunsg · Pull Request #577 · pythonindia/junction · GitHub

Open Graph Title: Change documentation generator to Sphinx by pradyunsg · Pull Request #577 · pythonindia/junction

X Title: Change documentation generator to Sphinx by pradyunsg · Pull Request #577 · pythonindia/junction

Description: This is an initial draft of the "new" documentation for Junction. Some of the changes made: Add Sphinx support Break up instructions for installation python-dev and build-essential are unrelated to setting up the project-specific environment. I have removed them for now but we can add them later. npm and NodeJS are installed together, no need to call them out separately. bower and grunt get installed as we go, so no need to ask for them to be installed already. Move old documentation in an old/ directory added a note to them, that they're old. Making a PR early to get feedback on the changes. Currently, the main "new" document is docs/source/development/getting-started.rst.

Open Graph Description: This is an initial draft of the "new" documentation for Junction. Some of the changes made: Add Sphinx support Break up instructions for installation python-dev and build-essential are u...

X Description: This is an initial draft of the "new" documentation for Junction. Some of the changes made: Add Sphinx support Break up instructions for installation python-dev and build-essenti...

Opengraph URL: https://github.com/pythonindia/junction/pull/577

X: @github

direct link

Domain: github.com

react-profiling0
react-import-mapreact,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/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:f68fa007-d54d-3d58-2d4d-c98e9d8b92ce
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-idB878:77A5A:282878F:34BDDA1:6B000A81
html-safe-nonce07ed3ec6c3aa7b72402a2523533d83b04a89afd02c79dd15b2fa07bafb8317a9
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCODc4Ojc3QTVBOjI4Mjg3OEY6MzRCRERBMTo2QjAwMEE4MSIsInZpc2l0b3JfaWQiOiIzNTAwMzY3Mjg2ODMxNjgwMTI5IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmace835cb7c20c42ce86f4e969ba756e8fb6ddbadf166f5212227c50fa038be6983
hovercard-subject-tagpull_request:266913055
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/pythonindia/junction/pull/577/files
twitter:imagehttps://avatars.githubusercontent.com/u/3275593?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/3275593?s=400&v=4
og:image:altThis is an initial draft of the "new" documentation for Junction. Some of the changes made: Add Sphinx support Break up instructions for installation python-dev and build-essential are u...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None0a0d8686a27478df474dd7415776a7a080cde8838b3cd92ea7601187572e5729
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/pythonindia/junction git https://github.com/pythonindia/junction.git
octolytics-dimension-user_id1763047
octolytics-dimension-user_loginpythonindia
octolytics-dimension-repository_id27966694
octolytics-dimension-repository_nwopythonindia/junction
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id27966694
octolytics-dimension-repository_network_root_nwopythonindia/junction
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release16a11879678aaf97e2a42c33ee70830aa084fa37
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/pythonindia/junction/pull/577/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpythonindia%2Fjunction%2Fpull%2F577%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
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
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://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/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpythonindia%2Fjunction%2Fpull%2F577%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=pythonindia%2Fjunction
Reloadhttps://github.com/pythonindia/junction/pull/577/files
Reloadhttps://github.com/pythonindia/junction/pull/577/files
Reloadhttps://github.com/pythonindia/junction/pull/577/files
pythonindiahttps://github.com/pythonindia
junctionhttps://github.com/pythonindia/junction
Codehttps://github.com/pythonindia/junction
Issues92 (92)https://github.com/pythonindia/junction/issues
Pull requests28 (28)https://github.com/pythonindia/junction/pulls
Actionshttps://github.com/pythonindia/junction/actions
Projectshttps://github.com/pythonindia/junction/projects
Wikihttps://github.com/pythonindia/junction/wiki
Security and qualityhttps://github.com/pythonindia/junction/security
Insightshttps://github.com/pythonindia/junction/insights
Sign up for GitHub https://github.com/signup?return_to=%2Fpythonindia%2Fjunction%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fpythonindia%2Fjunction%2Fissues%2Fnew%2Fchoose
pradyunsghttps://github.com/pradyunsg
pythonindia:masterhttps://github.com/pythonindia/junction/tree/master
Conversation 12 https://github.com/pythonindia/junction/pull/577
Commits 2 https://github.com/pythonindia/junction/pull/577/commits
Checks 0 https://github.com/pythonindia/junction/pull/577/checks
Files changed https://github.com/pythonindia/junction/pull/577/files
Please reload this pagehttps://github.com/pythonindia/junction/pull/577/files
Change documentation generator to Sphinx https://github.com/pythonindia/junction/pull/577/files#top
Show all changes 2 commits https://github.com/pythonindia/junction/pull/577/files
19fa3b6 Add an initial skeleton for Sphinx documentation pradyunsg Apr 3, 2019 https://github.com/pythonindia/junction/pull/577/commits/19fa3b62f955bc6268eee752027fa350cff3b2d8
344be6b Onboard existing documentation to new docs/ pradyunsg Apr 3, 2019 https://github.com/pythonindia/junction/pull/577/commits/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd
Clear filters https://github.com/pythonindia/junction/pull/577/files
Please reload this pagehttps://github.com/pythonindia/junction/pull/577/files
Please reload this pagehttps://github.com/pythonindia/junction/pull/577/files
Makefile https://github.com/pythonindia/junction/pull/577/files#diff-cdec797dddf8fc387304501d6bd4f318e1e9067c6fae012dfa8b69fd85fd3248
make.bat https://github.com/pythonindia/junction/pull/577/files#diff-eced23cf23b339d5a7dcd2246cb8fb515b1fa640975b585950c75ae19ba55feb
add_new_proposal_reviewer.png https://github.com/pythonindia/junction/pull/577/files#diff-357c2643bb3b5be1c86971bec3633e0fa71f0ce31b1474616a67f1159e4a1028
add_proposal_section_reviewer.png https://github.com/pythonindia/junction/pull/577/files#diff-6688878ccd746fcbe87fefd1528f8645b33bdc81315190a418dbcb3a1a13bf41
list_reviews.png https://github.com/pythonindia/junction/pull/577/files#diff-562a8809a2bf98a94e6742a33f4ee98f2a2cb7a3f1a538615d9f2064bf5ab35f
proposal_reviewers_list.png https://github.com/pythonindia/junction/pull/577/files#diff-ed6d42b372c08615325c209eddaf5acdfb9d06b310ac8c248da0c31ae9119d75
proposal_section_reviewer_list.png https://github.com/pythonindia/junction/pull/577/files#diff-86313612d107cb3f4ba978a5c3e85f5331707962ffec56b1f3aef3848a3e6911
reviewers_proposal_detail.png https://github.com/pythonindia/junction/pull/577/files#diff-b3dc24c6046050fadaf6e943868a9eebf58f5e08a869aa12c0e1883d5c8fd23f
reviewers_talk.png https://github.com/pythonindia/junction/pull/577/files#diff-9221e8e2edc07c9e507de6795e658a1435bb6a36f102c2f3ed3f773811e627ec
conf.py https://github.com/pythonindia/junction/pull/577/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698
getting-started.rst https://github.com/pythonindia/junction/pull/577/files#diff-63f2d1b3ab86868cc03e9c96906cf14eb6dbaacc6086ba542adfaf894ab1334d
index.rst https://github.com/pythonindia/junction/pull/577/files#diff-d7d2af9af9729ed1331913553f8232404d31175dfc64f8f0f3541b7f2b7bd417
index.rst https://github.com/pythonindia/junction/pull/577/files#diff-4eec6cec5f6fab1548b85433ea8ca81315ae165db4b7f84019f287df9015699f
api.md https://github.com/pythonindia/junction/pull/577/files#diff-4318a5c98915b61bb2b6fe6d7ca00673f13c843481a531c6222e084b55daf47b
conference_reviewers.md https://github.com/pythonindia/junction/pull/577/files#diff-9002fe1305380a3be9b228fc50741a793182e90f330ddebd8d729504d317e96a
index.md https://github.com/pythonindia/junction/pull/577/files#diff-812c561f8d0e2ba06bfee0f6d8688d640bfadbc97d1252fda4725c4829c835fd
release_notes.md https://github.com/pythonindia/junction/pull/577/files#diff-73d9b6192d24f88bbc792f082d363b2ff908dc46a4e1847888ceebfcb1e98315
docs/Makefilehttps://github.com/pythonindia/junction/pull/577/files#diff-cdec797dddf8fc387304501d6bd4f318e1e9067c6fae012dfa8b69fd85fd3248
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/Makefile
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/pythonindia/junction/pull/577/{{ revealButtonHref }}
docs/make.bathttps://github.com/pythonindia/junction/pull/577/files#diff-eced23cf23b339d5a7dcd2246cb8fb515b1fa640975b585950c75ae19ba55feb
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/make.bat
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/pythonindia/junction/pull/577/{{ revealButtonHref }}
docs/images/add_new_proposal_reviewer.png → ...atic/images/add_new_proposal_reviewer.pnghttps://github.com/pythonindia/junction/pull/577/files#diff-357c2643bb3b5be1c86971bec3633e0fa71f0ce31b1474616a67f1159e4a1028
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/_static/images/add_new_proposal_reviewer.png
Open in desktop https://desktop.github.com
.../images/add_proposal_section_reviewer.png → .../images/add_proposal_section_reviewer.pnghttps://github.com/pythonindia/junction/pull/577/files#diff-6688878ccd746fcbe87fefd1528f8645b33bdc81315190a418dbcb3a1a13bf41
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/_static/images/add_proposal_section_reviewer.png
Open in desktop https://desktop.github.com
docs/images/list_reviews.png → docs/source/_static/images/list_reviews.pnghttps://github.com/pythonindia/junction/pull/577/files#diff-562a8809a2bf98a94e6742a33f4ee98f2a2cb7a3f1a538615d9f2064bf5ab35f
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/_static/images/list_reviews.png
Open in desktop https://desktop.github.com
docs/images/proposal_reviewers_list.png → ...static/images/proposal_reviewers_list.pnghttps://github.com/pythonindia/junction/pull/577/files#diff-ed6d42b372c08615325c209eddaf5acdfb9d06b310ac8c248da0c31ae9119d75
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/_static/images/proposal_reviewers_list.png
Open in desktop https://desktop.github.com
...images/proposal_section_reviewer_list.png → ...images/proposal_section_reviewer_list.pnghttps://github.com/pythonindia/junction/pull/577/files#diff-86313612d107cb3f4ba978a5c3e85f5331707962ffec56b1f3aef3848a3e6911
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/_static/images/proposal_section_reviewer_list.png
Open in desktop https://desktop.github.com
docs/images/reviewers_proposal_detail.png → ...atic/images/reviewers_proposal_detail.pnghttps://github.com/pythonindia/junction/pull/577/files#diff-b3dc24c6046050fadaf6e943868a9eebf58f5e08a869aa12c0e1883d5c8fd23f
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/_static/images/reviewers_proposal_detail.png
Open in desktop https://desktop.github.com
docs/images/reviewers_talk.png → .../source/_static/images/reviewers_talk.pnghttps://github.com/pythonindia/junction/pull/577/files#diff-9221e8e2edc07c9e507de6795e658a1435bb6a36f102c2f3ed3f773811e627ec
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/_static/images/reviewers_talk.png
Open in desktop https://desktop.github.com
docs/source/conf.pyhttps://github.com/pythonindia/junction/pull/577/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/conf.py
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/pythonindia/junction/pull/577/{{ revealButtonHref }}
docs/source/development/getting-started.rsthttps://github.com/pythonindia/junction/pull/577/files#diff-63f2d1b3ab86868cc03e9c96906cf14eb6dbaacc6086ba542adfaf894ab1334d
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/development/getting-started.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/pythonindia/junction/pull/577/{{ revealButtonHref }}
docs/source/development/index.rsthttps://github.com/pythonindia/junction/pull/577/files#diff-d7d2af9af9729ed1331913553f8232404d31175dfc64f8f0f3541b7f2b7bd417
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/development/index.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/pythonindia/junction/pull/577/{{ revealButtonHref }}
docs/source/index.rsthttps://github.com/pythonindia/junction/pull/577/files#diff-4eec6cec5f6fab1548b85433ea8ca81315ae165db4b7f84019f287df9015699f
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/index.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/pythonindia/junction/pull/577/{{ revealButtonHref }}
docs/api.md → docs/source/old/api.mdhttps://github.com/pythonindia/junction/pull/577/files#diff-4318a5c98915b61bb2b6fe6d7ca00673f13c843481a531c6222e084b55daf47b
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/old/api.md
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/pythonindia/junction/pull/577/{{ revealButtonHref }}
https://github.com/pythonindia/junction/pull/577/files#diff-4318a5c98915b61bb2b6fe6d7ca00673f13c843481a531c6222e084b55daf47b
https://github.com/pythonindia/junction/pull/577/files#diff-4318a5c98915b61bb2b6fe6d7ca00673f13c843481a531c6222e084b55daf47b
https://github.com/pythonindia/junction/pull/577/files#diff-4318a5c98915b61bb2b6fe6d7ca00673f13c843481a531c6222e084b55daf47b
docs/conference_reviewers.md → docs/source/old/conference_reviewers.mdhttps://github.com/pythonindia/junction/pull/577/files#diff-9002fe1305380a3be9b228fc50741a793182e90f330ddebd8d729504d317e96a
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/old/conference_reviewers.md
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/pythonindia/junction/pull/577/{{ revealButtonHref }}
docs/index.md → docs/source/old/index.mdhttps://github.com/pythonindia/junction/pull/577/files#diff-812c561f8d0e2ba06bfee0f6d8688d640bfadbc97d1252fda4725c4829c835fd
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/old/index.md
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/pythonindia/junction/pull/577/{{ revealButtonHref }}
https://github.com/pythonindia/junction/pull/577/files#diff-812c561f8d0e2ba06bfee0f6d8688d640bfadbc97d1252fda4725c4829c835fd
docs/release_notes.md → docs/source/old/release_notes.mdhttps://github.com/pythonindia/junction/pull/577/files#diff-73d9b6192d24f88bbc792f082d363b2ff908dc46a4e1847888ceebfcb1e98315
View file https://github.com/pythonindia/junction/blob/344be6b0cb9ca158a5fefa09bd16dc9c897c6acd/docs/source/old/release_notes.md
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/pythonindia/junction/pull/577/{{ revealButtonHref }}
https://github.com/pythonindia/junction/pull/577/files#diff-73d9b6192d24f88bbc792f082d363b2ff908dc46a4e1847888ceebfcb1e98315
https://github.com/pythonindia/junction/pull/577/files#diff-73d9b6192d24f88bbc792f082d363b2ff908dc46a4e1847888ceebfcb1e98315
https://github.com/pythonindia/junction/pull/577/files#diff-73d9b6192d24f88bbc792f082d363b2ff908dc46a4e1847888ceebfcb1e98315
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.