Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Nen Sack voll documentation improvements #82

Closed
wants to merge 28 commits into from
Closed

Nen Sack voll documentation improvements #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
602fad1
docs: Removes the dysfunctional autoclasstoc
funkyfuture Dec 22, 2023
5dac4ce
docs/conf.py: Employs importlib.metadata
funkyfuture Dec 22, 2023
aa1c631
docs: Enables a previously defunct autodoc type alias
funkyfuture Dec 22, 2023
a0982b2
docs: Employs autodocsumm to generate categorized methods overviews
funkyfuture Dec 23, 2023
12302a0
docs: Adds build option to parallelize parts of the process
funkyfuture Dec 23, 2023
028f9d0
CHANGES.rst: Fixes minor issues in old records
funkyfuture Dec 23, 2023
c16b1bc
Adapts new docs: intersphinx_mapping format
funkyfuture Dec 22, 2023
69399fa
Updates RTD build environment configuration
funkyfuture Dec 23, 2023
adfd442
docs: Applies the furo theme 💫
funkyfuture Dec 23, 2023
18b461a
docs: Incorporates the glossary in the Design document
funkyfuture Dec 23, 2023
b4c2170
docs/installation.rst: Removes too specific information
funkyfuture Dec 23, 2023
864e6ce
docs: Extends TOC with links to external points of interest for users
funkyfuture Dec 23, 2023
cabd6dd
docs: Random edits that target better readability
funkyfuture Dec 23, 2023
648a37a
docs/design.rst: Improves section around the illustrative code example
funkyfuture Dec 23, 2023
070eec1
docs/extending.rst: Makes a neat overview section
funkyfuture Dec 23, 2023
5172eab
docs: Employs sphinx-copybutton
funkyfuture Dec 23, 2023
6b58df6
docs: Spreads API docs over several pages
funkyfuture Dec 24, 2023
d9e5969
Justfile: Adds the serve-docs recipe
funkyfuture Dec 24, 2023
4e91f72
docs/design.rst: Adds hyperlinks to two interesting resources
funkyfuture Dec 24, 2023
614fd7f
Employs flake8-rst-docstrings
funkyfuture Dec 26, 2023
e1846d0
docstrings: Adds missing descriptive summaries
funkyfuture Dec 27, 2023
e88af10
docs: Updates categories and tries to establish a docstring layout
funkyfuture Dec 27, 2023
4c5623c
docs/extending.rst: Fixes duplicate ref target name
funkyfuture Dec 27, 2023
d2e2421
docs/api: Adds section about type aliases and not so public interfaces
funkyfuture Dec 27, 2023
b178a29
docs: Improves presentation of NamedTuple subclasses
funkyfuture Dec 28, 2023
cc803b4
docs: Sorts sections of class member summaries
funkyfuture Jan 6, 2024
eecd645
docs: Updates several hyperlink targetss
funkyfuture Jan 6, 2024
b77328b
rm outdated python version specifier in rdt env config
JKatzwinkel Jan 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions .readthedocs.yml → .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,15 @@
version: 2

build:
image: latest
os: ubuntu-22.04
tools:
python: 3
JKatzwinkel marked this conversation as resolved.
Show resolved Hide resolved

formats: all

python:
version: 3.7
install:
- method: pip
path: .
- path: .
- requirements: docs/rtd-dependencies.txt


submodules:
include:
- lxml-stubs
...
9 changes: 6 additions & 3 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:tocdepth: 2

Changes
=======

Expand All @@ -19,7 +21,7 @@ News
- *delb* now uses its own XPath implementation, please investigate
:mod:`_delb.xpath` for details.
- ⚠️ Many of the nodes' methods that relate to relative nodes have been renamed.
Watch out for :py:class:`DeprecationWarning`\s!
Watch out for :class:`DeprecationWarning`\s!
- ⚠️ The method :meth:`delb.NodeBase.iterate_descendants` is added as a
replacement for the former :meth:`delb.NodeBase.child_nodes` invoked with the
now deprecated argument ``recurse``.
Expand Down Expand Up @@ -95,7 +97,7 @@ News
~~~~

- Adds a logo. Gracious thanks to sm!
- Adds :doc:`plugin mechanics <extending>`. Graciae ad infinitum, TC!
- Adds :doc:`plugin mechanics </api/extending>`. Graciae ad infinitum, TC!
- CSS and XPath query results are wrapped in :class:`delb.QueryResults`.
- Adds :attr:`delb.Document.head_nodes` and :attr:`delb.Document.tail_nodes`
that allow access to the siblings of a root node.
Expand All @@ -107,18 +109,19 @@ News
- Various documentation improvements, including table of contents for class
members.

.. _fastcache: https://pypi.org/project/fastcache/

0.1.2 (2019-09-14)
------------------

There's nothing super-exciting to report here. It's just getting better.


0.1.1 (2019-08-15)
------------------

This was quiet boring, it serves updated dependencies for what it's worth.


0.1 (2019-05-26)
----------------

Expand Down
6 changes: 5 additions & 1 deletion Justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,12 @@ release: tests
hatch build
hatch publish

# build and serve HTML documentation at 0.0.0.0:8000
serve-docs: docs
hatch run docs:serve

# build and open HTML documentation
showdocs: docs
show-docs: docs
xdg-open docs/build/html/index.html

# run all tests on normalized code
Expand Down
Loading