Comments (3)
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.
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.
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)
- [BUG] Wrong version from python package HOT 2
- [BUG] Pydantic model fields don't display in documentation HOT 4
- [BUG] Support typing-extensions 4.x HOT 2
- [BUG] Cannot extract docstring from output of `make_dataclass`
- Add support for help_text field parameter as description with django model fields.
- Line numbers in error messages HOT 1
- [BUG] Pytkdocs Loader assumes '_meta' attribute of classes has a 'get_fields' method HOT 5
- [DOCS] Docstrings don't match up with function parameters HOT 1
- [BUG] missing numpydoc parameters validation resulting in Nonetype exception HOT 2
- [BUG] use of `set` as class attribute type causes exception HOT 5
- [BUG] type unions with pipes not supported HOT 2
- [BUG] Wrong docstrings for attribute when aliased from another class HOT 2
- [BUG] detect_field_model fails for DjangoModelFactory from factory-boy HOT 3
- [BUG] Error displaying wrapped Python functions where wrapper is from another module HOT 3
- [BUG] 'builtin_function_or_method' object is not subscriptable HOT 2
- `inherited_members` Does **Not** Work HOT 4
- Decorators which alternate docstrings are ignored HOT 3
- [BUG] pandera model wrongly detected as pydantic and pytkdocs tries to read non existent attributes HOT 7
- pytkdocs/django compatibility issues HOT 5
- Decorator to ignore specific functions during the docstrings "discovery" HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pytkdocs.