Rename Doc/README.txt to Doc/README.rst and add formatting#104
Conversation
ghost
mentioned this pull request
ghost
changed the title
| both style and markup, is available in the "Documenting Python" chapter of the | ||
| developers guide <https://docs.python.org/devguide/documenting.html>. | ||
| both style and markup, is available in the "`Documenting Python <https://docs.python.org/devguide/documenting.html>`_" chapter of the | ||
| developers guide. |
There was a problem hiding this comment.
folding long line is preferred.
|
@methane That line is now folded. |
|
Has anyone tested to make sure the docs build doesn't pick up and build README.rst? I'm not sure that it would be harmful, but would be unnecessary. |
|
@zware nice catch! @rogersachan There are two problem.
(I feel markdown is better for README now. But I was too late.) |
methane
left a comment
methane
left a comment
There was a problem hiding this comment.
Please update Makefile and conf.py
|
@methane I have made the requested changes. |
| Bugs in the toolset should be reported in the Sphinx bug tracker at | ||
| https://www.bitbucket.org/birkenfeld/sphinx/issues/. | ||
| Bugs in the toolset should be reported in the | ||
| `Sphinx bug tracker <https://www.bitbucket.org/birkenfeld/sphinx/issues/>`_. |
There was a problem hiding this comment.
This link is outdated, it's now https://github.com/sphinx-doc/sphinx/issues
|
@Haypo I have made the requested changes. |
vstinner
dismissed
methane’s stale review
"methane: @rogersachan There are two problem." these issues have been fixed
|
Thanks, I merged your PR. Right now http://sphinx-doc.org/ link displays "Diese Präsenz ist leider nicht verfügbar." error message in german, whereas http://www.sphinx-doc.org/ redirects to http://www.sphinx-doc.org/en/stable/ which is the expected website. But I hope that the error is only temporary. Otherwise, we can fix that later. I reported this issue on IRC. |
|
The Windows installer build picks up this readme file and distributes it as I vote we should keep both so that we can distribute the file without rst formatting. (As an aside, we also read the /LICENSE file, so if someone wants to come in and "fix" that too then they'll also need to update the installer.) |
This issue is about Doc/README.txt, but Tools/msi/exe/exe_files.wxs seems to refer to README.txt (root directory). See PR #2 which renamed README.txt to README.rst. This PR was followed by PR #70, PR #73 and #21. Is it common to provide README as plain text on Windows? Would it be possible to provide a README formatted as HTML? It would look nicer than plain text, no? It would also allow to keep new features like images (well, "badges"). For example, on Linux I'm running manually "rst2html README.rst README.html". |
|
Ah, I see. This PR just modified the one at the root, which is why it showed up as the last commit for the file. It doesn't matter whether it's common or not - it's a functional change that should have been on bpo and signed off by the RMs (who are responsible for keeping at least the header in the file up to date). This may just be Ned, depending on where the change was backported to. |
|
I opened http://bugs.python.org/issue29579 |
…honGH-104) (cherry picked from commit b3f1f59)
…itialisation Initialise slp_initial_tstate early, as in Stackless 2.7. https://bitbucket.org/stackless-dev/stackless/issues/104
|
Thanks @rogersachan for the PR, and @Haypo for merging it 🌮🎉.. I'm working now to backport this PR to: 2.7. |
|
Sorry, @rogersachan and @Haypo, I could not cleanly backport this to |
|
I don't think that we need to backport this change to Python 2.7, so I removed the "needs backport to 2.7". |
Theologian 01:53:41Z draft per shepard 01:53:07Z + pythia python#104 (3) + supervisor 01:53:55Z GO. Adds proactive complement to existing gate python#3 (HEAD==binary AND tree-clean during build, REACTIVE detection at build-symptom). 4-step discipline for multi-file (≥2) edit sequences: 1. Pre-edit baseline snapshot 2. Mid-edit integrity check (HALT on unexpected change) 3. Pre-commit verification (HALT if staged diff diverges) 4. HALT response (clean-HEAD restore + observed-but-not-attributed report; do NOT auto-resume) Rationale: 5+ prior incidents caused gate failures + false BUILD PASS + ARM64 build BLOCK (D-1775810621, D-1775669703, D-1776414469, D-1776434533, D-1776887480/D-1776890644 per librarian 01:46:19Z). Triggered by 01:23Z external file-state revert during Tier 8 pilot Phase A execution (generalist 01:24:43Z observed-but-not-attributed HALT + clean-HEAD restore demonstrated the prescribed response). Doc-only +14L. No §3.5 BUILD MODE per touched-files rule (no builder*.{cpp,h,c} touched).
…DE.md Bundle of two theologian-authored doc amendments per supervisor dispositions: CLAUDE.md (+2L) — Pre-Edit WT Integrity 'undiagnosed-recurring' honest framing per pythia python#105 (3) + supervisor 02:13:12Z + theologian 02:13:54Z. Acknowledges 5+ prior incidents closed at SYMPTOM layer without root-cause attribution; this 4-step discipline codifies reactive HALT, not automated detection. Detection still depends on agent noticing mid-edit. Recurrence-prevention claim does not exceed what text mechanizes; automated detection feasibility (file-watcher / git-hook) is fixup PIR territory and remains open. docs/tier8-class-b-cport-migrate-arm-spec.md (+93/-20) — pythia python#104 amendments per theologian 01:38:08Z + supervisor 01:38:26Z + 01:37:05Z: §1.1 container-shape transferability caveat (vector-pilot ≠ hash/ stack/allocator-shape pattern transferability) §5 python#11 NEW: bridge-count-delta acceptance (each pilot must NET- SUBTRACT bridges OR honestly add with W45 fixture coverage) §5 python#12 NEW: Phase B FORCING-FUNCTION (Tier 8 SECOND-PILOT block_map_ Step A BLOCKED until exception_table_ Phase B commit lands) Bundle scope: doc-only, no §3.5 BUILD MODE (no builder*.{cpp,h,c} touched). Atomic per supervisor 02:13:12Z + 01:38:26Z dispositions. Push 28 advances the Tier 8 Phase A resume deadline tracker per theologian 02:13:54Z + supervisor 02:13:12Z (push 28 OR session-end whichever first). If Alex disposition + fixup PIR not received by deadline, theologian amends Phase 3 closure summary fa8dfef to remove Tier 8 pilot citation + re-opens pythia python#103 escape question.
7 participants
I have simply updated the document and its references to README.rst (thanks to whoever formatted it).