Repository navigation
docs: move the process pages out of the docs top level (#901) - #912
Conversation
* `git mv` conventions.rst, releasing.rst, testing.rst, workflows.rst and pep.rst into a new `docs/source/contributing/` subdirectory. Named explicitly by the owner (conventions, releasing, testing); workflows and pep join them since both are contributor/process-facing (CI graph and the roadmap) rather than library-usage docs. demo.rst, ext.rst and changelog.rst stay -- they're what a reader of the library, not a contributor, wants at the root; index.rst is the root document. * Update `docs/source/index.rst`'s toctree to the new paths, in its own block. This moves `changelog` from last to third in the rendered nav. * Fix the one cross-tree `:doc:` reference the move broke: `pcapkit/protocols/internet/mh.rst` pointed at `/pep`, now `/contributing/pep`. Eleven `:doc:` references in pep.rst gained the leading `/` its new directory needs -- ten into `pcapkit/`, plus one to `/ext`, a page that stays at the root. The relative sibling references that genuinely needed no change are in releasing.rst (-> `pep`) and workflows.rst (-> `releasing`, five times), and they survive only because those two pages moved together; leaving either behind would have broken all six. * Update the plain-text path mentions that don't resolve as Sphinx roles: CONTRIBUTING.md, README.md's rendered-doc link, a workflow comment, and four docstring/comment references to conventions.rst under tests/. Sphinx build: 58 warnings, unchanged from the 58-warning baseline (fresh BUILDDIR, doc root confirmed as this worktree via PYTHONPATH). `util/ changelog_md.py --check` exits 0, unaffected since changelog.rst didn't move. The real setuptools sdist ships the same 928 entries before and after, with identical `tar tzf` listings; six of those files do change content -- README.md, both PKG-INFO copies and the three tests/ modules, since MANIFEST.in's `prune test` does not match `tests/` -- all of it comment, docstring and URL text. tests/project/ (178 tests) and the touched unit tests all pass. Pure move plus reference fixes, no new logic, so no coverage change is expected.
c38640a to
c239631
Compare
|
Good to merge — cross-review on a different model (sonnet; authored by opus) came back needs changes, prose only, and I have made exactly those fixes. The tree is byte-identical to the reviewed one ( What it verified: four of the five moves are What it disputed, all three confirmed by me directly and now corrected:
Unverified and stated as such: the author's intermediate 59-warning build was not reproduced, and |
…912 tense (#920) - `_sentinel_section()` walked a two-element candidate tuple whose first entry, `docs/source/conventions.rst`, has not existed since #912 moved the file in `9806f16aa`. The loop always fell through to the second, so it was dead code that read as though both locations were still live. Resolved to the real path directly instead. - Its docstring described the move as something #912 "is making". #912 has merged; the tense now says so. Comment-only and docstring-only; no assertion changed. Verified: `tests/corekit/test_sentinel_exports_unit.py` 18 tests OK, `tests/project/test_isort_clean.py` OK, and no occurrence of the pre-move path survives anywhere under `pcapkit/`, `tests/` or `docs/`.
make pylint,make mypy,make isort)make testpasses, and a test case covers the changedocs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visibleWhat is the purpose of your pull request?
fixfeatperfrefactortestdocscichoreDescription of your pull request and other information
Closes #901. Moves
conventions.rst,releasing.rst,testing.rst,workflows.rstandpep.rstinto a newdocs/source/contributing/subdirectory viagit mv, one commit.demo.rst,ext.rstandchangelog.rststay at the top level (library-usage docs, not process);index.rstis the root document.Fixed every reference the move touched:
index.rst's toctree, the one cross-tree:doc:link that broke (pcapkit/protocols/internet/mh.rst→/pep),pep.rst's own eleven:doc:links, which gained a leading/-- ten intopcapkit/, plus one to/ext, a page that stays at the root, and the plain-text path mentions inCONTRIBUTING.md,README.md, a workflow comment, and four test docstrings/comments.Splitting the toctree moves
changelogfrom last to third in the rendered nav.Sphinx build: 58 warnings, same as the 58-warning baseline (delta 0).
util/changelog_md.py --checkexits 0 (unaffected --changelog.rstdidn't move). The real setuptools sdist ships the same 928 entries before and after, with identicaltar tzflistings. Six of those files do change content --README.md, bothPKG-INFOcopies and the threetests/modules, sinceMANIFEST.in'sprune testdoes not matchtests/-- all of it comment, docstring and URL text.make isortclean;make pylint/make mypycarry their pre-existing, advisory findings, none in a file this PR touches (nopcapkit/*.pychanged). Rantests/project/(178 tests) plus the touched unit tests rather than the full suite, which OOMs locally.Changelog: N/A -- changelog centralised in #657.