-
Notifications
You must be signed in to change notification settings - Fork 1
Sphynx branch #19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Sphynx branch #19
Conversation
|
hello @dumaatravaie ; would you have some time to review this PR? |
|
Ok; i will have a look .. |
|
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. |
There was a problem hiding this 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 ...
|
For example, when we click on [ source ] |
|
Now, it looks better |
dumaatravaie
left a comment
There was a problem hiding this 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 ..
There was a problem hiding this 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 ?
|
Ok, after discussion with @sifaoufatai , i am going to merge this pull request .. |
i set up sphynx for documentyation .