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 not showing up in Scripts section in RTD

See original GitHub issue

In the RTD, documentation for a few scripts currently doesn’t show up at https://ivadomed.org/scripts.html. The missing scripts are:

  • ivadomed_visualize_transforms
  • ivadomed_automate_training
  • ivadomed_prepare_dataset_vertebral_labeling

As can be seen in docs/source/scripts.rst, the documentation for this part is generated with autofunction.

What is interesting is, when I do

cd docs
make html

as instructed here and locally look at the docs, there is no problem. Somehow this only happens when deployed.

I tried to find a latest build that doesn’t have this issue from here but I haven’t been successful yet.

Issue Analytics

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

github_iconTop GitHub Comments

2reactions
jcohenadadcommented, Dec 24, 2021

Since this is not high priority, let’s leave it for now. Someone from @dyt811 team could look at it at their convenient schedule.

0reactions
konantiancommented, Apr 8, 2022

This issue has been resolved in PR #1104. The root cause is after we upgraded torchio to a newer version, it does not support importing int_classes from torch._six anymore and caused a bunch of warnings in build 1033. The current solution is to replace the int_classes with int to avoid this issue.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Populating our documentation - Sphinx-RTD-Tutorial
Running the above command will process any Sphinx source files contained within the simpleble-master/docs/source (i.e. our Sphinx source ) ...
Read more >
Plotly plots rendered by nbsphinx not showing in ... - GitHub
Plotly plots rendered by nbsphinx show (both locally and remotely) when using Alabaster just fine, but they don't show at all when using...
Read more >
How to Set Up Your Python Project Docs for Success
In this article, I'll show you how to set up your docs so you can give your ... Read the Docs (RTD) hosts...
Read more >
General Issues and Workarounds - Oracle Help Center
This chapter describes general issues and workarounds for Oracle RTD. ... Section 3.3.8, "Model APIs Not Working Correctly With Only One Positive Event"....
Read more >
SphinxTutorial Documentation - Read the Docs
Also, since this tutorial aims to show how to publish project documentation on ReadTheDocs, then we will also need to download the RTD...
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