IBM/simulai

Docs still ignore third level of directories ("sub-sub-packages").

Joao-L-S-Almeida opened this issue · 12 comments

For example:

simulai
   |- > regression
         | - > pytorch (directory) --> ignored
         | - > _opinf.py (module) --> parsed
            :
            .

Can you describe the problem in detail?

In some cases there are sub-directories inside the sub-packages, which are not parsed by Sphinx/Read the Docs. For example, for the sub-package regression:
Captura de tela de 2023-01-25 12-04-56
It ignores the content of the directory pytorch
Captura de tela de 2023-01-25 12-06-57

@Joao-L-S-Almeida Now I get it, can you check it out? I updated : #61

Yes, @TarikKaanKoc, it works now. A similar issue occurs for simulai/models, which has a sub-directory _pytorch_models, but I think the question is answered now. Thanks.

It still does not appear in this latest docs build: https://simulai-toolkit.readthedocs.io/en/latest/?badge=latest
Maybe I'm missing some detail ?
Thanks.

Did you make a build version on the readthedocs site after merging it with the pr main branch I forwarded? @Joao-L-S-Almeida

branch: #61

After the document is updated, click the button here "build version"

Hi. The build should occur automatically after each commit/pull request. I cannot force the build using Read the Docs I`m accessing.
Captura de tela de 2023-01-26 19-46-10

This feature is not enabled by default and to enable it:

  • Readthedocs, go to the project homepage
  • Select "settings" in the menu on the left.
  • Go to the "Advanced Settings" tab.
  • Activate the "Build on commits" option under the "Automatic Building" heading.
  • Click the "Save" button.

After doing these operations, ReadTheDocs will automatically update your documents every time you commit. Did you do this?

No, I still didn't. I'll configure it. The docs are now updated after your latest commits. Thanks.