search

frictionlessdata / datapackage-py

A Python library for working with Data Packages.
https://frictionlessdata.io
MIT License
189 stars 44 forks source link

Connecting to datapackage docs via intersphinx #258

Closed danielhuppmann closed 4 years ago

danielhuppmann commented 4 years ago

Overview

Is there a url to connect to the datapackage-API docs using intersphinx when building the docs for a package that can read/write datapackage.Package? None of the documentations on frictionless.io, pypi, conda-forge or this repo seem to have this...

i.e., a resource that can be used in this way.

intersphinx_mapping = {
    'python': ('https://docs.python.org/3', None),
    'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
}

Please preserve this line to notify @roll (lead of this repository)

roll commented 4 years ago

Hi @danielhuppmann,

I'm not sure it's possible due to we don't use Sphinx formatted docstrings.

For now, the entry points for the docs is https://github.com/frictionlessdata/datapackage-py#datapackage-py but we're working on a dedicated docs protal atm

danielhuppmann commented 4 years ago

Thanks! I added this as a link in our docs for now - but it would be great to have the reference build automatically with intersphinx in the future.

roll commented 4 years ago

Thanks!

cc @lwinfree https://pyam-iamc.readthedocs.io/en/latest/index.html