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.

Documentation broken or source reference missing?

See original GitHub issue

None of the class links in the doc, such as MPI.Comm work (but intersphinx links such as pickle do work).

On top of that there also doesn’t seem to be a way to view the reference docs or source code docs. Is the doc build broken?

Issue Analytics

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

github_iconTop GitHub Comments

1reaction
bdicecommented, Mar 5, 2021

@dalcinl Excellent, I agree with your assessment. I maintain some Cython packages with C++ extension modules (https://freud.readthedocs.io/en/stable/) and the documentation can work fine as long as the package can be built with the right flags and imported during the build. I will take a look at this and see if mpi4py would work using the same approaches I’ve used before.

1reaction
Helvegcommented, Mar 3, 2021

Same as @bdice, I can help out and probably even use it as an opportunity to learn about some more exotic functions. Maybe just pick 1 option @dalcinl to get us started and if it turns out it was the wrong choice we can deal with its shortcomings in the future. I’d say it’s better to have some API docs now, than the perfect API docs in a future that might never come ;p

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Fix Error Reference Source not Found when Printing ...
Method 2: Removing all broken references manually · First, select all text by pressing Ctrl + A. · Once the fields have been...
Read more >
Error, Reference source not found - Microsoft Office issue
If you have encountered Error! Reference source not found message in Microsoft Office programs, these fixes are sure to help you.
Read more >
Troubleshoot broken references - Visual Studio - Microsoft Learn
To fix a broken project reference by correcting the reference path. In Solution Explorer, right-click your project node, and then select ...
Read more >
How to FIX BROKEN References in Mendeley for Manuscripts
I showed easy tricks to import references and fix broken ones. Very easy and simple to implement technique. Watch related playlists and ...
Read more >
Solve issues with EndNote references in a document
Open a blank Word document and insert a few references. If the problem persists even in your new document, your problem is more...
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