Giter Club home page Giter Club logo

Comments (4)

macfreek avatar macfreek commented on June 18, 2024

Hi @nedbat, could you test the latest version?

Nearly all internal and external links are now properly supported. The only issue still left is the :ref: role that you use. :ref: is Sphinx-specific, and the output of restbuilder should not contain Sphinx-specific directives or roles. The issue that I can't find a good way to replicated the behaviour in "plain" reStructuredText, only something which is close. I put the technical details in #20.

from restbuilder.

nedbat avatar nedbat commented on June 18, 2024

Thanks, the links are working now. I'm not sure what you mean about an issue remaining with :ref:, those seem fine in my use.

There's an issue with list indentation which I will put into a new issue.

from restbuilder.

macfreek avatar macfreek commented on June 18, 2024

Thanks, the links are working now. I'm not sure what you mean about an issue remaining with :ref:, those seem fine in my use.

The issue is minor. In your above example:

see :ref:`whatsnew5x`.

becomes:

see `Major changes in 5.0 <whatsnew5x.rst#whatsnew5x>`_.

which would subsequently be rendered as:

see <a class="reference external" href="whatsnew5x.rst#whatsnew5x">Major changes in 5.0</a>.

The class="external" is incorrect. It is an internal reference. However, I can't think of a reStructuredText structure which produces internal links between two documents.

For now, this is good enough. I will add some more tests and fix issues I encounter. After that, I'll close this issue.

There's an issue with list indentation which I will put into a new issue.

Please do. I'm there are plenty of bugs left, but adding issues will prioritise my efforts.

from restbuilder.

macfreek avatar macfreek commented on June 18, 2024

More testing revealed that there was still a minor bug.

see :ref:`whatsnew5x`.

would work if whatsnew5x was a target in a different file, but not if the target was in the same file. That is now fixed, so I have closed this issue.

from restbuilder.

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.