Skip to content

Commit 1d0a65f

Browse files
committed
cleanup docs, make consistent, use furo
More misc cleanup.
1 parent 0a30408 commit 1d0a65f

File tree

4 files changed

+15
-23
lines changed

4 files changed

+15
-23
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# stdlib-list
22

3-
This package includes lists of all of the standard libraries for Python 2.6,
4-
2.7, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, and 3.9 along with the code for
5-
scraping the official Python docs to get said lists.
3+
This package includes lists of all of the standard libraries for Python 2.6
4+
through 3.11.
65

76
**IMPORTANT**: If you're on Python 3.10 or newer, you **probably don't need this library**.
87
See [`sys.stdlib_module_names`](https://docs.python.org/3/library/sys.html#sys.stdlib_module_names)

docs/conf.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,9 @@
3030
extensions = [
3131
"sphinx.ext.autodoc",
3232
"sphinx.ext.viewcode",
33-
"sphinx_rtd_theme",
3433
]
3534

36-
html_theme = "sphinx_rtd_theme"
35+
html_theme = "furo"
3736

3837
# Add any paths that contain templates here, relative to this directory.
3938
templates_path = ["_templates"]
@@ -48,8 +47,8 @@
4847
master_doc = "index"
4948

5049
# General information about the project.
51-
project = "Python Standard Library List"
52-
copyright = "2015, Jack Maney"
50+
project = "stdlib-list"
51+
copyright = "2015, stdlib-list authors"
5352

5453
# The version info for the project you're documenting, acts as replacement for
5554
# |version| and |release|, also used in various other places throughout the

docs/index.rst

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,15 @@
1-
.. Python Standard Library List documentation master file, created by
2-
sphinx-quickstart on Tue Mar 10 02:16:08 2015.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
1+
stdlib-list
2+
===========
53

6-
Python Standard Library List
7-
========================================================
4+
This package includes lists of all of the standard libraries for Python 2.6
5+
through 3.11.
86

9-
This package includes lists of all of the standard libraries for Python 2.6, 2.7, 3.2, 3.3, and 3.4, along with the code for scraping the official Python docs to get said lists.
7+
.. note::
108

11-
Listing the modules in the standard library? Wait, why on Earth would you care about that?!
12-
===========================================================================================
13-
14-
Because knowing whether or not a module is part of the standard library will come in handy in `a project of mine <https://github.com/jackmaney/pypt>`_. `And I'm not the only one <http://stackoverflow.com/questions/6463918/how-can-i-get-a-list-of-all-the-python-standard-library-modules>`_ who would find this useful. Or, the TL;DR answer is that it's handy in situations when you're analyzing Python code and would like to find module dependencies.
15-
16-
After googling for a way to generate a list of Python standard libraries (and looking through the answers to the previously-linked Stack Overflow question), I decided that I didn't like the existing solutions. So, I started by writing a scraper for the TOC of the Python Module Index for each of the versions of Python above.
17-
18-
However, web scraping can be a fragile affair. Thanks to `a suggestion <https://github.com/jackmaney/python-stdlib-list/issues/1#issuecomment-86517208>`_ by `@ncoghlan <https://github.com/ncoghlan>`_, and some further help from `@birkenfeld <https://github.com/birkenfeld>`_ and `@epc <https://github.com/epc>`_, the population of the lists is now done by grabbing and parsing the Sphinx object inventory for the official Python docs of each relevant version.
9+
If you're on Python 3.10 or newer, you **probably don't need this library**.
10+
See `sys.stdlib_module_names <https://docs.python.org/3/library/sys.html#sys.stdlib_module_names>`_
11+
and `sys.builtin_module_names <https://docs.python.org/3/library/sys.html#sys.builtin_module_names>`_
12+
for similar functionality.
1913

2014
Contents
2115
========

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Source = "https://github.com/pypi/stdlib-list"
3030
[project.optional-dependencies]
3131
test = ["pytest", "pytest-cov", "coverage[toml]"]
3232
lint = ["black", "mypy", "ruff"]
33-
doc = ["sphinx", "sphinx_rtd_theme"]
33+
doc = ["sphinx", "furo"]
3434
dev = ["build", "stdlib-list[test,lint,doc]"]
3535
# CI only: used for list generation for Python versions < 3.10.
3636
support = ["sphobjinv"]

0 commit comments

Comments
 (0)