Giter Site home page Giter Site logo

Comments (1)

samccann avatar samccann commented on August 31, 2024

Near as I can tell, rstcheck doesn't validate for a well-formed URI inside the hyperlink. The docutils spec for RST is here - https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliases
The links that are quietly broken (not found by CI), are as follows:
Control Node Requirements <:ref:control-node-requirements>_
So it has a title (Control Node Requirements) and a URI . So if nothing acutally checks the blablabla, the test passes.
That syntax is used for external links. The internal link syntax is :ref:Control Node Requirments <blablabla>
and if that were incorrect, rstcheck would flag it.
So a correct external link would be Control Node Requirements <http://docs.ansible.com/blablbla>_
aka it was a clever way of combining the two to seem like it would work, but didn't, and didn't fail tests either

from community-team.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.