Skip to content

Documentaion on readthedocs#87

Merged
baugetfa merged 16 commits intomasterfrom
78-documentation-on-readthedocs
Feb 16, 2026
Merged

Documentaion on readthedocs#87
baugetfa merged 16 commits intomasterfrom
78-documentation-on-readthedocs

Conversation

@pradal
Copy link
Copy Markdown
Contributor

@pradal pradal commented Oct 13, 2025

No description provided.

@pradal pradal linked an issue Oct 13, 2025 that may be closed by this pull request
@pradal
Copy link
Copy Markdown
Contributor Author

pradal commented Oct 13, 2025

This PR need to be updated.
But .readthedocs.yml need to be fixed.
environment.yaml need to be moved in conda dir
and hexversion python package need to be added

@baugetfa
Copy link
Copy Markdown
Contributor

baugetfa commented Feb 4, 2026

  • hexversion is no longer used

Copy link
Copy Markdown
Contributor

@thomasarsouze thomasarsouze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some bugs I've detected when deploying documentation localy:

  • In "Usage" section
    • One thumbnail missing
    • One tutorial in french (Simple viewer)
    • One tutorial with incomplete display (Example GM2009)
    • Interactive view failing
  • API documentation missing (only one function right now)

I don't know if we have time to tackle part or all of this before release...

@baugetfa
Copy link
Copy Markdown
Contributor

baugetfa commented Feb 6, 2026

  • Yes in fact noted the thumbnail missing and the API
  • But I do see French in simple Viewer, I do not have text only code
  • incomplete display it is because if there is at least one cell output then the nb is not run during doc building

I think I can manage these unless API before release announcement .

@thomasarsouze
Copy link
Copy Markdown
Contributor

@baugetfa I'll give a look to API then

@baugetfa
Copy link
Copy Markdown
Contributor

baugetfa commented Feb 6, 2026

the CI failed as in PyRATP so it is general see openalea/action-build-publish-anaconda#97.
We were lucky to release before

@baugetfa baugetfa force-pushed the 78-documentation-on-readthedocs branch from 6adeb3b to 5f4b8ec Compare February 6, 2026 13:04
@baugetfa
Copy link
Copy Markdown
Contributor

baugetfa commented Feb 6, 2026

@baugetfa I'll give a look to API then

In the future we'll have to decide the layout for example something like (it is for PyRatp:

.. autosummary::
    :toctree: _autosummary
    :template: 
    :recursive:
    
    openalea.ratp.can2riri
    openalea.ratp.clumping_index
    openalea.ratp.grid
    openalea.ratp.IOtable
    openalea.ratp.micrometeo
    openalea.ratp.mtg2ratp
    openalea.ratp.mtg_extract
    openalea.ratp.Nallocate
    openalea.ratp.RATP2VTK
    openalea.ratp.RatpScene
    openalea.ratp.runratp
    openalea.ratp.skyvault
    openalea.ratp.test
    openalea.ratp.vege3D
    openalea.ratp.vegetation
    openalea.ratp.interface.clumping_index
    openalea.ratp.interface.color_map
    openalea.ratp.interface.display
    openalea.ratp.interface.geometry
    openalea.ratp.interface.pgl_scene
    openalea.ratp.interface.post_processing
    openalea.ratp.interface.ratp_scene
    openalea.ratp.interface.smart_grid
    openalea.ratp.interface.surfacic_point_cloud

@baugetfa baugetfa merged commit 8554e35 into master Feb 16, 2026
8 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation on ReadTheDocs

4 participants