docutils-develop

[Docutils-develop] [docutils:patches] #191 Update URLs

[Adam T. <aa-...@us...>]

---

** [patches:#191] Update URLs **

**Status:** open
**Group:** None
**Created:** Thu Jan 20, 2022 04:40 AM UTC by Adam  Turner
**Last Updated:** Thu Jan 20, 2022 04:40 AM UTC
**Owner:** nobody


Documentation / minor change. 

There are a lot of old URLs in the repo -- e.g. `docutils.sf.net`, `docutils.sourceforge.net` -- whilst these currently still work, we should update them all to the canonical `https://docutils.sourceforge.io` 

This patch does that, and also generally updates several other links to `https://` -- I tested each domain, so didn't update some old sourceforge domains that don't support `https://`. I also updated the `docutils.dtd` IDN in a single commit, so it can be dropped if wanted. 

I'd certainly reccomend applying the first 4 commits, and ideally the entire patch. 

https://github.com/AA-Turner/docutils/pull/10 // https://github.com/AA-Turner/docutils/pull/10.patch

A


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:patches] #191 Update URLs

[Günter M. <mi...@us...>]

Thank you for the patch. Most of it is applied now.

Changing the IDN breaks the validity of generated XML documents:

    #test/functional/expected >  xmllint standalone_rst_docutils_xml.xml --valid --noout
    standalone_rst_docutils_xml.xml:4: validity error : Validation failed: no DTD found !
Maybe this is also why flake8 failed? 
https://github.com/AA-Turner/docutils/runs/4877613719?check_suite_focus=true

Commit 6/6 did not apply cleanly here and is also flagged "Some checks were not successful", so I leave it for now.



---

** [patches:#191] Update URLs **

**Status:** open
**Group:** None
**Created:** Thu Jan 20, 2022 04:40 AM UTC by Adam  Turner
**Last Updated:** Thu Jan 20, 2022 04:40 AM UTC
**Owner:** nobody


Documentation / minor change. 

There are a lot of old URLs in the repo -- e.g. `docutils.sf.net`, `docutils.sourceforge.net` -- whilst these currently still work, we should update them all to the canonical `https://docutils.sourceforge.io` 

This patch does that, and also generally updates several other links to `https://` -- I tested each domain, so didn't update some old sourceforge domains that don't support `https://`. I also updated the `docutils.dtd` IDN in a single commit, so it can be dropped if wanted. 

I'd certainly reccomend applying the first 4 commits, and ideally the entire patch. 

https://github.com/AA-Turner/docutils/pull/10 // https://github.com/AA-Turner/docutils/pull/10.patch

A


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:patches] #191 Update URLs

[Adam T. <aa-...@us...>]

> Changing the IDN breaks the validity of generated XML documents:

I thought it was a bit of a riskier change!

> Commit 6/6 did not apply cleanly here 

Yeah, commit 6 won't apply if you don't apply #5 -- I kept them apart but should have thought about that, sorry. See https://github.com/AA-Turner/docutils/pull/11 // https://github.com/AA-Turner/docutils/pull/11.patch for the "clean" commit #6

> Maybe this is also why flake8 failed? // flagged "Some checks were not successful"

Flake8 fails on master with the following errors -- it wasn't anything I introduced

```
docutils/frontend.py:389:47: F821 undefined name 'locale_encoding'
docutils/utils/math/latex2mathml.py:861:1: C901 'handle_cmd' is too complex (68)
docutils/utils/math/latex2mathml.py:1210:52: E712 comparison to True should be 'if cond is True:' or 'if cond:'
docutils/utils/math/latex2mathml.py:1221:52: E712 comparison to True should be 'if cond is True:' or 'if cond:'
docutils/utils/math/math2html.py:2350:18: F821 undefined name 'Label'
docutils/utils/math/math2html.py:2353:5: F821 undefined name 'Label'
```

A


---

** [patches:#191] Update URLs **

**Status:** open
**Group:** None
**Created:** Thu Jan 20, 2022 04:40 AM UTC by Adam  Turner
**Last Updated:** Thu Jan 20, 2022 09:57 AM UTC
**Owner:** nobody


Documentation / minor change. 

There are a lot of old URLs in the repo -- e.g. `docutils.sf.net`, `docutils.sourceforge.net` -- whilst these currently still work, we should update them all to the canonical `https://docutils.sourceforge.io` 

This patch does that, and also generally updates several other links to `https://` -- I tested each domain, so didn't update some old sourceforge domains that don't support `https://`. I also updated the `docutils.dtd` IDN in a single commit, so it can be dropped if wanted. 

I'd certainly reccomend applying the first 4 commits, and ideally the entire patch. 

https://github.com/AA-Turner/docutils/pull/10 // https://github.com/AA-Turner/docutils/pull/10.patch

A


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:patches] Re: #191 Update URLs

[Günter M. <mi...@us...>]

On 2022-01-20, Adam Turner via Docutils-develop wrote in gmane.text.docutils.devel:

>> Changing the IDN breaks the validity of generated XML documents:

> I thought it was a bit of a riskier change!

>> Commit 6/6 did not apply cleanly here 

> See > https://github.com/AA-Turner/docutils/pull/11.patch for the "clean"
> commit #6

This is a massive change. I split it in documentation vs. code changes,
fixed/updated some more URLs left out changes for "historic" docs, and
dropped the change in MathML namespace specifiers to keep them valid.

...

> Flake8 fails on master with the following errors -- it wasn't anything I introduced

Fixed. Thanks for telling.


Thank you for your contributions.


---

** [patches:#191] Update URLs **

**Status:** open
**Group:** None
**Created:** Thu Jan 20, 2022 04:40 AM UTC by Adam  Turner
**Last Updated:** Thu Jan 20, 2022 12:09 PM UTC
**Owner:** nobody


Documentation / minor change. 

There are a lot of old URLs in the repo -- e.g. `docutils.sf.net`, `docutils.sourceforge.net` -- whilst these currently still work, we should update them all to the canonical `https://docutils.sourceforge.io` 

This patch does that, and also generally updates several other links to `https://` -- I tested each domain, so didn't update some old sourceforge domains that don't support `https://`. I also updated the `docutils.dtd` IDN in a single commit, so it can be dropped if wanted. 

I'd certainly reccomend applying the first 4 commits, and ideally the entire patch. 

https://github.com/AA-Turner/docutils/pull/10 // https://github.com/AA-Turner/docutils/pull/10.patch

A


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:patches] Re: #191 Update URLs

[Adam T. <aa-...@us...>]

Sorry if it caused a headache. It was really a search + replace http:// to https:// but I didn't want to do a commit per domain or etc. as it would have been many many small commits. 

Didn't realise the MathML point -- all tests passed, but if I changed the URL in the test then it is sort of a no-op. 

Thanks for fixing Flake8!

A


---

** [patches:#191] Update URLs **

**Status:** open
**Group:** None
**Created:** Thu Jan 20, 2022 04:40 AM UTC by Adam  Turner
**Last Updated:** Thu Jan 20, 2022 12:09 PM UTC
**Owner:** nobody


Documentation / minor change. 

There are a lot of old URLs in the repo -- e.g. `docutils.sf.net`, `docutils.sourceforge.net` -- whilst these currently still work, we should update them all to the canonical `https://docutils.sourceforge.io` 

This patch does that, and also generally updates several other links to `https://` -- I tested each domain, so didn't update some old sourceforge domains that don't support `https://`. I also updated the `docutils.dtd` IDN in a single commit, so it can be dropped if wanted. 

I'd certainly reccomend applying the first 4 commits, and ideally the entire patch. 

https://github.com/AA-Turner/docutils/pull/10 // https://github.com/AA-Turner/docutils/pull/10.patch

A


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

Re: [Docutils-develop] [docutils:patches] Re: #191 Update URLs

[Guenter M. <mi...@us...>]

On 2022-01-21, Adam Turner wrote:

> Sorry if it caused a headache. It was really a search + replace http://
> to https:// 

However, this needs to be followed by a check of the resulting URL
(some work fine with htpp but not https (because of non-standard
certificates) or, as sourceforge, because they changed the domain for some
https services.
>From the patch and its meta-data I did not find out whether (and to what
extend) you did this checks. So I decided to double-check.

> but I didn't want to do a commit per domain or etc. as it
> would have been many many small commits. 

Fair enough. Still, separating the changes in documentation and code seemed a
good idea to me.

> Didn't realise the MathML point -- all tests passed, but if I changed
> the URL in the test then it is sort of a no-op. 

Changing code and tests in one search + replace operation is dangerous,
because this can lead to both beeing faulty. I made it a habit to only
change the tests after looking at the difference.

Before moving changed documents from "functional/output" to 
"functional/expected", changes also need an additional check:

- convert *.tex documents with `pdflatex` or `xelatex`/`lualatex`
  and inspected the PDF for problems.
- check *.xml documents with `xmllint --valid`
- inspect *.html documents in a browser (or several different browsers)
  and check the validity (the standalone_*html documents have a button in
  the footer for this).

[Docutils-develop] [docutils:patches] #191 Update URLs

[Günter M. <mi...@us...>]

- **status**: open --> closed-fixed



---

** [patches:#191] Update URLs **

**Status:** closed-fixed
**Group:** None
**Created:** Thu Jan 20, 2022 04:40 AM UTC by Adam  Turner
**Last Updated:** Fri Jan 21, 2022 05:48 PM UTC
**Owner:** nobody


Documentation / minor change. 

There are a lot of old URLs in the repo -- e.g. `docutils.sf.net`, `docutils.sourceforge.net` -- whilst these currently still work, we should update them all to the canonical `https://docutils.sourceforge.io` 

This patch does that, and also generally updates several other links to `https://` -- I tested each domain, so didn't update some old sourceforge domains that don't support `https://`. I also updated the `docutils.dtd` IDN in a single commit, so it can be dropped if wanted. 

I'd certainly reccomend applying the first 4 commits, and ideally the entire patch. 

https://github.com/AA-Turner/docutils/pull/10 // https://github.com/AA-Turner/docutils/pull/10.patch

A


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.