Skip to content

Commit

Permalink
reintroduce docs/*.inv
Browse files Browse the repository at this point in the history
- ci(.gitignore): remove ignore of docs/*.inv
- ci(pre-commit): remove remove-intersphinx-inventory-files, need docs/*.inv
- docs(Makefile): store *.inv needed by readthedocs
- docs: remove objects-python.txt, excessive file size
- docs: in code manual, add todo list page
  • Loading branch information
msftcangoblowm committed Apr 19, 2024
1 parent 79f87fd commit 105a0e0
Show file tree
Hide file tree
Showing 17 changed files with 43 additions and 16,520 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,3 @@ dmypy.json
# Removed from project
retired/
src/sphinx_external_toc_strict/_version.py
docs/*.inv
15 changes: 0 additions & 15 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,3 @@ repos:
- id: mypy
pass_filenames: false
entry: mypy src/sphinx_external_toc_strict/

- repo: local
hooks:
- id: remove-intersphinx-inventory-files
name: remove-intersphinx-inventory-files
entry: python igor.py quietly "make inv2txt" docs/
language: python
pass_filenames: false
description: >
Remove intersphinx .inv file that has corresponding .txt file
stages:
- commit
- merge-commit
- push
- manual
14 changes: 12 additions & 2 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,23 @@ Changelog
Known regressions
..................

1. Dropped support for hidden document files

Commit items for NEXT VERSION
..............................

.. scriv-start-here
.. _changes_1-1-6:

Version 1.1.6 — 2024-04-19
--------------------------

- ci(.gitignore): remove ignore of docs/*.inv
- ci(tox): in docs do not build_inv after clean_inv
- ci(pre-commit): remove remove-intersphinx-inventory-files, need docs/*.inv
- docs(Makefile): store *.inv needed by readthedocs
- docs: remove objects-python.txt, excessive file size
- docs: in code manual, add todo list page
.. _changes_1-1-5:

Version 1.1.5 — 2024-04-19
Expand Down
6 changes: 3 additions & 3 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ ifeq ($(is_venv),1)
endif

.PHONY: htmlall
htmlall: build_inv ## Sphinx build clean and build html
htmlall: ## Sphinx build clean and build html
ifeq ($(is_venv),1)
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html"
endif
Expand All @@ -84,7 +84,7 @@ endif
##@ Test

.PHONY: linkcheck
linkcheck: build_inv ## Sphinx check urls within docs and code base
linkcheck: ## Sphinx check urls within docs and code base
ifeq ($(is_venv),1)
@$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" || echo "$(err_check_web_conn). exit code $$?"
endif
Expand Down Expand Up @@ -137,7 +137,7 @@ obj_strictyaml:
# -q quiet
# --keep-going even if there are warnings
.PHONY: doctest
doctest: build_inv ## Confirm in-doc code does what it claims
doctest: ## Confirm in-doc code does what it claims
ifeq ($(is_venv),1)
@$(MAKE) htmlall
$(SPHINXBUILDNOOPT) -b doctest "$(SOURCEDIR)" "$(BUILDDIR)"
Expand Down
4 changes: 4 additions & 0 deletions docs/code/todo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
To do
======

.. todolist::
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@
# @@@ editable
copyright = "2023–2024, Dave Faulkmore"
# The short X.Y.Z version.
version = "1.1.5"
version = "1.1.6"
# The full version, including alpha/beta/rc tags.
release = "1.1.5"
release = "1.1.6"
# The date of release, in "monthname day, year" format.
release_date = "April 19, 2024"
# @@@ end
Expand Down Expand Up @@ -137,7 +137,7 @@
"https://docutils.sourceforge.io",
("objects-docutils-source.inv", "objects-docutils-source.txt"),
),
"sphinx-docs": ( # source logging-strict
"sphinx-docs": ( # source logging-strict. Alternative? https://www.sphinx-doc.org/objects.inv
"https://www.sphinx-doc.org/en/master",
("objects-sphinx-docs.inv", "objects-sphinx-docs.txt"),
),
Expand Down
5 changes: 5 additions & 0 deletions docs/objects-black.inv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Sphinx inventory version 2
# Project: black 23.12.1
# Version: 23.12.1
# The remainder of this file is compressed using zlib.
xڥ�1� ��)u 8��!@�qH$,� �>��H.�l���q �æ�9�$b��T!f>W�n߹�1�fm7��v9�.�D��I����&H�E�4�A{�ꎈj�?�tBo���jy6[Ki�,,[,�ɿuח2�� j�V
Binary file added docs/objects-docutils-source.inv
Binary file not shown.
Binary file added docs/objects-python.inv
Binary file not shown.
16,493 changes: 0 additions & 16,493 deletions docs/objects-python.txt

This file was deleted.

6 changes: 6 additions & 0 deletions docs/objects-sphinx-docs.inv
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Sphinx inventory version 2
# Project: Sphinx 7.2.6
# Version: 7.2.6
# The remainder of this file is compressed using zlib.
xڕλ�0 Н��+A�l�66��(q��ԉb�*O�2�d���Ȝ�H�6)�F0���J���Ymt���%�Pߥ˕Z/xܵ�*��8��׀Z̑j ч�;����K�dC\�\�t�m
F#��x��E;��� 3X��SB��OȥA�;�r��o� ���6
Expand Down
5 changes: 5 additions & 0 deletions docs/objects-strictyaml-docs.inv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Sphinx inventory version 2
# Project: strictyaml 1.7.3
# Version: 1.7.3
# The remainder of this file is compressed using zlib.
xڍϱ! �ݧ�����urr�T@!J�%'o�ab Q�c����ONq��{��D*ۀ:{#��Emn���E��WPaH���$ӒL.^%�dA>c-b�By �X����b�:R�h�����$�K�@�-<�����k�i8�{���O�r��x�T�]dJ�5AW~�Q���_����
Binary file added docs/objects-strictyaml-source.inv
Binary file not shown.
Binary file added docs/objects-toc-strict.inv
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/user_guide/regressions.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ Proof, in ToC, can mix markdown and RestructuredText files

Package needs to be tested. There is a waiting PR that needs to be looked at too!

## Dropped support

- hidden document files

## Enhancements

These are proposed enhancements
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ linkcheck_ignore = [
]
myst_enable_extensions = ["colon_fence", "html_image"]
external_toc_exclude_missing = true
todo_include_todos = true

exclude_patterns = [
"_build",
Expand Down
3 changes: 0 additions & 3 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,10 @@ deps =
allowlist_externals =
make
commands =
make --directory=docs build_inv
sphinx-build -b html -aEnqW docs docs/_build/html
rst2html.py --strict README.rst docs/_build/trash
- sphinx-build -b html -b linkcheck -aEnq docs docs/_build/html
- sphinx-build -b html -b linkcheck -aEnQW docs docs/_build/html
commands_post =
make --directory=docs clean_inv

[testenv:lint]
description = pre-commit and build
Expand Down

0 comments on commit 105a0e0

Please sign in to comment.