Docs updates (#76)

* updating docs and release tools

* more newsfragments

* towncrier commands in Makefile

* update towncrier underlines to match existing docs

* new underlinew

* new underlinew

* underlines

* underlines

* lint

* makefile cleanup

* remove readme.html stuff

* add build dev dependency and verify can build

* update dns tool dependency from aiodns to dnspython

Author: pacrob

.bumpversion.cfg

@@ -58,9 +58,6 @@ coverage.xml
 # Sphinx documentation
 docs/_build/
 
-# File just for checking my RST syntax
-readme.html
-
 # PyBuilder
 target/
 

.gitignore

@@ -1,6 +1,8 @@
 History
 =======
 
+.. towncrier release notes start
+
 0.0.7 (2019-5-8)
 ----------------
 

HISTORY.rst

@@ -11,20 +11,6 @@ endef
 export BROWSER_PYSCRIPT
 BROWSER := python -c "$$BROWSER_PYSCRIPT"
 
-help:
-	@echo "clean - remove all build, test, coverage and Python artifacts"
-	@echo "clean-build - remove build artifacts"
-	@echo "clean-pyc - remove Python file artifacts"
-	@echo "clean-test - remove test and coverage artifacts"
-	@echo "lint - check style with ruff"
-	@echo "test - run tests quickly with the default Python"
-	@echo "test-all - run tests on every Python version with tox"
-	@echo "coverage - check code coverage quickly with the default Python"
-	@echo "docs - generate Sphinx HTML documentation, including API docs"
-	@echo "release - package and upload a release"
-	@echo "dist - package"
-	@echo "install - install the package to the active Python's site-packages"
-
 clean: clean-build clean-pyc clean-test
 
 clean-build:
@@ -81,24 +67,41 @@ docs:
 servedocs: docs
 	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
 
-readme.html: README.rst
-	rst2html.py README.rst > readme.html
-
 .PHONY: authors
 authors:
 	git shortlog --numbered --summary --email | cut -f 2 > AUTHORS
 
 dist: clean
-	python setup.py sdist
-	python setup.py bdist_wheel
+	python -m build
+	ls -l dist
 
 install: clean
 	python setup.py install
 
-bump:
-	bumpversion --tag-name "{new_version}" patch
-
-deploy-prep: clean authors readme.html docs dist
+# build newsfragments into release notes and verify docs build correctly
+notes: check-bump validate-newsfragments
+	# Let UPCOMING_VERSION be the version that is used for the current bump
+	$(eval UPCOMING_VERSION=$(shell bump-my-version bump --dry-run $(bump) -v | awk -F"'" '/New version will be / {print $$2}'))
+	# Now generate the release notes to have them included in the release commit
+	towncrier build --yes --version $(UPCOMING_VERSION)
+	# Before we bump the version, make sure that the towncrier-generated docs will build
+	make docs
+	git commit -m "Compile release notes for v$(UPCOMING_VERSION)"
+
+deploy-prep: clean authors docs dist
 	@echo "Did you remember to bump the version?"
 	@echo "If not, run 'bumpversion {patch, minor, major}' and run this target again"
 	@echo "Don't forget to update HISTORY.rst"
+
+# helpers
+
+# verify that newsfragments are valid and towncrier can build them
+validate-newsfragments:
+	python ./newsfragments/validate_files.py
+	towncrier build --draft --version preview
+
+# verify that a bump argument is set to be passed to bump-my-version
+check-bump:
+ifndef bump
+	$(error bump must be set, typically: major, minor, patch, or devnum)
+endif

Makefile

@@ -5,9 +5,10 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
-    multiaddr.codecs
-    multiaddr.resolvers
+   multiaddr.codecs
+   multiaddr.resolvers
 
 Submodules
 ----------
@@ -16,39 +17,38 @@ multiaddr.exceptions module
 ---------------------------
 
 .. automodule:: multiaddr.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :show-inheritance:
+   :undoc-members:
 
 multiaddr.multiaddr module
 --------------------------
 
 .. automodule:: multiaddr.multiaddr
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :show-inheritance:
+   :undoc-members:
 
 multiaddr.protocols module
 --------------------------
 
 .. automodule:: multiaddr.protocols
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :show-inheritance:
+   :undoc-members:
 
 multiaddr.transforms module
 ---------------------------
 
 .. automodule:: multiaddr.transforms
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+   :members:
+   :show-inheritance:
+   :undoc-members:
 
 Module contents
 ---------------
 
 .. automodule:: multiaddr
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/multiaddr.rst

@@ -1,4 +1,3 @@
-# flake8: noqa: F811
 import collections.abc
 from collections.abc import Iterator, Sequence
 from typing import Any, Optional, TypeVar, Union, overload

multiaddr/multiaddr.py

@@ -0,0 +1 @@
+Added support for CIDv1 format and improved sequence protocol handling with enhanced indexing and slicing operations.

newsfragments/65.feature.rst

@@ -0,0 +1 @@
+Enhanced type safety with comprehensive type hints, improved validation, and expanded test coverage for better code reliability and maintainability.

newsfragments/65.internal.rst

@@ -0,0 +1 @@
+Adds DNSADDR protocol support.

newsfragments/68.feature.rst

@@ -0,0 +1 @@
+Adds support for p2p-circuit addresses.