Skip to content

Conversation

@sifaoufatai
Copy link
Contributor

@sifaoufatai sifaoufatai commented Jun 19, 2025

i set up sphynx for documentyation .

@SylvainTakerkart
Copy link
Contributor

hello @dumaatravaie ; would you have some time to review this PR?

@dumaatravaie
Copy link
Contributor

Ok; i will have a look ..

@dumaatravaie
Copy link
Contributor

I have checked the documents created by sphynx. As, i understood, the content of the document was created automatically by Sphynx from the code source. The automatically created document just try to explain each function: mainly their parameters and the return value type. But, it can be deployed in its present form either on github or on readthedocs. Changing the contents of this doc manually may not be possible as it depends on the code source.

Copy link
Contributor

@dumaatravaie dumaatravaie left a comment

Choose a reason for hiding this comment

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

Its fine for the moment. Can you please try to change the style of your docs in read the docs please. Source codes are not showing the complete line ...

@dumaatravaie
Copy link
Contributor

For example, when we click on [ source ]
https://elabforms.readthedocs.io/en/latest/_modules/elabforms/generate_templates.html#check_template_parts_structure , the lines are not displayed entirely ..

@dumaatravaie
Copy link
Contributor

Now, it looks better

Copy link
Contributor

@dumaatravaie dumaatravaie left a comment

Choose a reason for hiding this comment

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

Yes, it looks good ..

Copy link
Contributor

@dumaatravaie dumaatravaie left a comment

Choose a reason for hiding this comment

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

Is this page public ? Is it connected with elabforms of github ?

@dumaatravaie
Copy link
Contributor

Ok, after discussion with @sifaoufatai , i am going to merge this pull request ..

@dumaatravaie dumaatravaie merged commit 7e53692 into INT-NIT:main Jul 2, 2025
1 check 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.

3 participants