René's URL Explorer Experiment


Title: doc: Clean up and modernize sphinx configuration (fixes #463) by acolomb · Pull Request #465 · canopen-python/canopen · GitHub

Open Graph Title: doc: Clean up and modernize sphinx configuration (fixes #463) by acolomb · Pull Request #465 · canopen-python/canopen

X Title: doc: Clean up and modernize sphinx configuration (fixes #463) by acolomb · Pull Request #465 · canopen-python/canopen

Description: The Sphinx build currently depends on pkg_resources from the setuptools distribution. That is long deprecated however, causing documentation builds to fail. Presumably that is the reason for #463, and can be fixed easily by using importlib.metadata. The changes here are based on a fresh invocation of sphinx-quickstart (version 7.2.6), trying to format our existing modifications in the same style. The changes are broken up into several smaller commits to keep the diff readable. Comments on each step are in the commit messages.

Open Graph Description: The Sphinx build currently depends on pkg_resources from the setuptools distribution. That is long deprecated however, causing documentation builds to fail. Presumably that is the reason for #463...

X Description: The Sphinx build currently depends on pkg_resources from the setuptools distribution. That is long deprecated however, causing documentation builds to fail. Presumably that is the reason for #463...

Opengraph URL: https://github.com/canopen-python/canopen/pull/465

X: @github

direct link

Domain: github.com

route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:92bdd083-a660-1d04-5f09-d5fb52012bcd
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-id8138:1712DC:AA0DFDF:E497A64:6A5EA514
html-safe-nonce7688793a74d8aaa41d223357570e02da7effc57f0ad518e19c6e66d15c44de02
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4MTM4OjE3MTJEQzpBQTBERkRGOkU0OTdBNjQ6NkE1RUE1MTQiLCJ2aXNpdG9yX2lkIjoiMjQ2Nzk2Njk0NTQwNjY1NzgxMiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmaca923c95a5fee548b9c4c1d72f82e7f67b11792566dca7be2ecbb4ab551e4460e
hovercard-subject-tagpull_request:1925867620
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/canopen-python/canopen/pull/465/files
twitter:imagehttps://avatars.githubusercontent.com/u/6996887?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/6996887?s=400&v=4
og:image:altThe Sphinx build currently depends on pkg_resources from the setuptools distribution. That is long deprecated however, causing documentation builds to fail. Presumably that is the reason for #463...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None7c7e31acb6a895494e518b880f5ccf39604f7fa9a8f2f3c64145efc3b776256d
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/canopen-python/canopen git https://github.com/canopen-python/canopen.git
octolytics-dimension-user_id200581454
octolytics-dimension-user_logincanopen-python
octolytics-dimension-repository_id68737600
octolytics-dimension-repository_nwocanopen-python/canopen
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id68737600
octolytics-dimension-repository_network_root_nwocanopen-python/canopen
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
release2d2ac9bdd71d5f53f2b731c9330677e38624e301
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/canopen-python/canopen/pull/465/files#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fcanopen-python%2Fcanopen%2Fpull%2F465%2Ffiles
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub Copilot appDirect agents from issue to mergehttps://github.com/features/ai/github-app
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
Code QualityEnforce quality at mergehttps://github.com/features/code-quality
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
View all resourceshttps://github.com/resources
GitHub SponsorsFund open source developershttps://github.com/open-source/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/open-source/accelerator
GitHub Starshttps://stars.github.com
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/enterprise/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://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fcanopen-python%2Fcanopen%2Fpull%2F465%2Ffiles
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%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=canopen-python%2Fcanopen
Reloadhttps://github.com/canopen-python/canopen/pull/465/files
Reloadhttps://github.com/canopen-python/canopen/pull/465/files
Reloadhttps://github.com/canopen-python/canopen/pull/465/files
Please reload this pagehttps://github.com/canopen-python/canopen/pull/465/files
canopen-python https://github.com/canopen-python
canopenhttps://github.com/canopen-python/canopen
Notifications https://github.com/login?return_to=%2Fcanopen-python%2Fcanopen
Fork 359 https://github.com/login?return_to=%2Fcanopen-python%2Fcanopen
Star 561 https://github.com/login?return_to=%2Fcanopen-python%2Fcanopen
Code https://github.com/canopen-python/canopen
Issues 53 https://github.com/canopen-python/canopen/issues
Pull requests 20 https://github.com/canopen-python/canopen/pulls
Discussions https://github.com/canopen-python/canopen/discussions
Actions https://github.com/canopen-python/canopen/actions
Projects https://github.com/canopen-python/canopen/projects
Security and quality 0 https://github.com/canopen-python/canopen/security
Insights https://github.com/canopen-python/canopen/pulse
Code https://github.com/canopen-python/canopen
Issues https://github.com/canopen-python/canopen/issues
Pull requests https://github.com/canopen-python/canopen/pulls
Discussions https://github.com/canopen-python/canopen/discussions
Actions https://github.com/canopen-python/canopen/actions
Projects https://github.com/canopen-python/canopen/projects
Security and quality https://github.com/canopen-python/canopen/security
Insights https://github.com/canopen-python/canopen/pulse
Sign up for GitHub https://github.com/signup?return_to=%2Fcanopen-python%2Fcanopen%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fcanopen-python%2Fcanopen%2Fissues%2Fnew%2Fchoose
acolombhttps://github.com/acolomb
canopen-python:masterhttps://github.com/canopen-python/canopen/tree/master
acolomb:sphinx-cleanuphttps://github.com/acolomb/canopen/tree/sphinx-cleanup
Conversation 0 https://github.com/canopen-python/canopen/pull/465
Commits 14 https://github.com/canopen-python/canopen/pull/465/commits
Checks 0 https://github.com/canopen-python/canopen/pull/465/checks
Files changed https://github.com/canopen-python/canopen/pull/465/files
Please reload this pagehttps://github.com/canopen-python/canopen/pull/465/files
doc: Clean up and modernize sphinx configuration (fixes #463) https://github.com/canopen-python/canopen/pull/465/files#top
Show all changes 14 commits https://github.com/canopen-python/canopen/pull/465/files
bfb7077 Switch from setuptools' pkg_resources to importlib.metadata. acolomb Jun 17, 2024 https://github.com/canopen-python/canopen/pull/465/commits/bfb707761f7b22f49b49981cc2f0e8a2a43b468c
18d27c2 Update string literals to assume UTF-8 default. acolomb Jun 17, 2024 https://github.com/canopen-python/canopen/pull/465/commits/18d27c28532c72a09cec1cf654053312e1bcd038
e4700d0 Remove commented Sphinx configuration options. acolomb Jun 17, 2024 https://github.com/canopen-python/canopen/pull/465/commits/e4700d01da46dc08383925a7a3745f37d8ca7273
191a377 Remove Sphinx options which are at their default. acolomb Jun 17, 2024 https://github.com/canopen-python/canopen/pull/465/commits/191a37706a247e6940ca9a8b55bbfe77e7fc7323
e0b44bb Reorder, project settings first. acolomb Jun 17, 2024 https://github.com/canopen-python/canopen/pull/465/commits/e0b44bb7e2d765c4335ee6188bceb27c1f2a8aa8
0a72c7d Remove explanatory comments on configuration options. acolomb Jun 17, 2024 https://github.com/canopen-python/canopen/pull/465/commits/0a72c7de7552380d9873b64759188b89e3dc8c45
4c3a26e Include section headers as generated via sphinx-quickstart. acolomb Jun 17, 2024 https://github.com/canopen-python/canopen/pull/465/commits/4c3a26ed63ff10abdd062efde125b717e4d77ed4
57bc71b Remove default HTML theme option. acolomb Jun 17, 2024 https://github.com/canopen-python/canopen/pull/465/commits/57bc71b98b4376011bfe210017a8e4b39b28cd3a
79136d5 Reorder (sort) extensions. acolomb Jun 17, 2024 https://github.com/canopen-python/canopen/pull/465/commits/79136d59bdee9de02128ca3aba7c08752bedcc62
47009b4 Fix undefined default language. acolomb Jun 17, 2024 https://github.com/canopen-python/canopen/pull/465/commits/47009b4ea38dfbc5e0e5673379fc3779fdfcaf2f
57c845f Rename modernized Sphinx options. acolomb Jun 17, 2024 https://github.com/canopen-python/canopen/pull/465/commits/57c845fc52c6777397345896df393cb1ccc5b2ad
f1c7cb1 Clean up section headings and move autodoc option down. acolomb Jun 18, 2024 https://github.com/canopen-python/canopen/pull/465/commits/f1c7cb1a701681c14e53373855c4c1ccb5629dc1
6020c37 Whitespace cleanup. acolomb Jun 18, 2024 https://github.com/canopen-python/canopen/pull/465/commits/6020c37d245562e9034843c6a08dbcdfbf15d321
9e5c384 Import Makefile generated by sphinx-quickstart. acolomb Jun 18, 2024 https://github.com/canopen-python/canopen/pull/465/commits/9e5c3842f8343c2b14d2f5ff0952d317b9b50a4a
Clear filters https://github.com/canopen-python/canopen/pull/465/files
Please reload this pagehttps://github.com/canopen-python/canopen/pull/465/files
Please reload this pagehttps://github.com/canopen-python/canopen/pull/465/files
Makefile https://github.com/canopen-python/canopen/pull/465/files#diff-f48ddfd1eec38c4d39f84e195259371f8397cd30146f46b113bdcb4590ed262c
conf.py https://github.com/canopen-python/canopen/pull/465/files#diff-e170e9a7d787c21095c6c11bb25f0f1ff0294a42a46d45ba6fb5ed794e457624
doc/Makefilehttps://github.com/canopen-python/canopen/pull/465/files#diff-f48ddfd1eec38c4d39f84e195259371f8397cd30146f46b113bdcb4590ed262c
View file https://github.com/acolomb/canopen/blob/9e5c3842f8343c2b14d2f5ff0952d317b9b50a4a/doc/Makefile
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/canopen-python/canopen/pull/465/{{ revealButtonHref }}
Please reload this pagehttps://github.com/canopen-python/canopen/pull/465/files
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.