Git Product home page Git Product logo

Comments (6)

mwaskom avatar mwaskom commented on May 24, 2024

What is object.inv? There is not a file with that name in the repository.

from seaborn.

buhtz avatar buhtz commented on May 24, 2024

There is not a file with that name in the repository.

Don't have to be. It is auto generated by your doc systems (e.g. Sphinx). Here it is (binary): https://seaborn.pydata.org/objects.inv

What is object.inv?

It is a file generated by your doc system. It can be used by other doc systems so that one doc can link to another doc just by naming the object (e.g. a class or method) instead of using a full URL.
You do use that feature yourself. See the last lines in your docs/conf.py:

intersphinx_mapping = {
    'numpy': ('https://numpy.org/doc/stable/', None),
    'scipy': ('https://docs.scipy.org/doc/scipy/', None),
    'matplotlib': ('https://matplotlib.org/stable', None),
    'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
    'statsmodels': ('https://www.statsmodels.org/stable/', None)
}

Your Sphinx machine do look for a object.inv file in this URLs.

Reference about objects.inv: https://sphobjinv.readthedocs.io/en/stable/syntax.html

You as "seaborn" do offer an objects.inv. But it lacks of a root package reference. Other docus can use seaborn objects in there docstrings but not the package name itself. I don't know how to configure sphinx to acheiv this. I opened a question in Sphinx discussions.

You can take a look what is inside this your objects.inv:

$ python3 -m sphinx.ext.intersphinx https://seaborn.pydata.org/objects.inv

from seaborn.

mwaskom avatar mwaskom commented on May 24, 2024

Feel free to look into it. I'll accept a simple fix to the docs configuration if you can come up with one.

from seaborn.

buhtz avatar buhtz commented on May 24, 2024

Sorry, no expertise in that and also no resources for Sphinx.

from seaborn.

mwaskom avatar mwaskom commented on May 24, 2024

OK, I'm going to close then. I don't consider this a bug in seaborn; third-party sites that want a reference for "seaborn" can link to the doc homepage, which makes more sense anyway.

from seaborn.

buhtz avatar buhtz commented on May 24, 2024

You are a maintainer and it is up to you of course. Compared to other packages (python, matplotlib, pandas, numpy, webcolors, openpyxl, PIL, ...) it is unusual not to have such a root reference in the objects.inv.

from seaborn.

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.