Coder Social home page Coder Social logo

Comments (5)

lesteve avatar lesteve commented on June 15, 2024

Not sure I follow you completely.

Are you talking about this example: http://sphinx-gallery.readthedocs.org/en/latest/auto_examples/plot_function_identifier.html#sphx-glr-auto-examples-plot-function-identifier-py

names = spback.identify_names(file_code)

The problem being that identify_names doesn't show up as a link?

from sphinx-gallery.

Titan-C avatar Titan-C commented on June 15, 2024

Yes that is my current problem.

from sphinx-gallery.

Titan-C avatar Titan-C commented on June 15, 2024

Well this issue was a sample size of one. Testing on nilearn and my own repositories. I notice that not all functions/classes are captured. On what it depends to have the function/class documentation in the JSON file that sphinx generates and that the gallery uses to resolve the links is beyond my understanding. There are some function links that will be missing from our modules or from the externals (numpy, scipy, matplotlib, scikit-learn).

from sphinx-gallery.

Titan-C avatar Titan-C commented on June 15, 2024

I reference this to #113 because is on the issues on understanding what sphinx resolves as function documentation.

from sphinx-gallery.

Titan-C avatar Titan-C commented on June 15, 2024

Closing this. After merging #214, sphinx-gallery does recognize our autosummary generated documentation for sphinx-gallery and the trouble function spback.indentify_names has a link to the docs

from sphinx-gallery.

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.