GithubHelp home page GithubHelp logo

Comments (3)

StephenBrown2 avatar StephenBrown2 commented on June 8, 2024 1

Sphinx does this with it's own magic, but has an extension to link to other project's documentation called "intersphinx": http://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
This relies on an "inventory" mapping file being available, and so may not be the exact thing you're looking for, but the example to view the links is here.

Here is an example configuration cribbed from another project I worked on that used Sphinx for docs:

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
    'python': ('https://docs.python.org/3', None),
    'cryptography': ('https://cryptography.io/en/latest', None),
}

from pytkdocs.

pawamoy avatar pawamoy commented on June 8, 2024

This is definitely interesting. I feel like I'm trying to reinvent the wheel haha.

I was indeed thinking that instead of maintaining a global mapping, each project could serve its own mapping file. We would just need to retrieve the doc page for each project, then their mapping files, and use that to create cross references.

from pytkdocs.

pawamoy avatar pawamoy commented on June 8, 2024

Partially implemented in mkdocstrings, which is now able to load and use Sphinx inventories to reference external objects. The new griffe collector will return objects' API paths so mkdocstrings can add further references.

from pytkdocs.

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.