question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

class methods do not have doc pages

See original GitHub issue

Describe the bug Many PVSystem class methods do not have doc pages.

To Reproduce Go to the PVSystem doc page, notice that many methods don’t have links.

Versions:

  • pvlib.__version__: 0.8.0b0

A of couple of approaches to consider:

Might try adding sphinx 3.1 :recursive: option here. There’s some compatibility reason we’re on an older version of sphinx (maybe a sphinx gallery issue?).

Modify the sphinx autosummary class template.

Manually document the methods in api.rst. We should be doing this anyways.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

2reactions
kanderso-nrelcommented, Sep 29, 2020

There’s some compatibility reason we’re on an older version of sphinx (maybe a sphinx gallery issue?).

See https://github.com/pvlib/pvlib-python/issues/911#issuecomment-591233524, it was because of poor formatting in the sphinx 2.x html output and nuisance warnings. Looks like a lot of development has gone into Sphinx since February, so if we want to start using sphinx features added after 1.8.5, it’s probably worth trying out the current release again!

1reaction
cwhansecommented, Oct 5, 2020

Duplicate links don’t bother me. If someone is looking up a method, they may be asking “what can I do with PVSystem” or they could be asking “what are the options for the _____ model”?

If I understand correct, we either add :recursive: where a Class appears in api.rst, or, we add an line for every class method. Either one would be maintainable for those who need a pattern to follow.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Write Doc Comments for the Javadoc Tool - Oracle
This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, ...
Read more >
Page — PyMuPDF 1.21.1 documentation - Read the Docs
Class representing a document page. A page object is created by Document.load_page() or, equivalently, via indexing the document like doc[n] - it has...
Read more >
Built-in Functions — Python 3.11.1 documentation
The Python interpreter has a number of functions and types built into it that are always available. They are listed here in alphabetical...
Read more >
Partial Classes and Methods - C# Programming Guide
The calls to the method, including any results that would occur from evaluation of arguments in the calls, have no effect at run...
Read more >
Classes - JavaScript - MDN Web Docs
Classes in JS are built on prototypes but also have some syntax and semantics that are not shared with ES5 class-like semantics.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found