Skip to content

Jlc/add documentation init#277

Open
johanseto wants to merge 5 commits intomasterfrom
jlc/add-documentation-init
Open

Jlc/add documentation init#277
johanseto wants to merge 5 commits intomasterfrom
jlc/add-documentation-init

Conversation

@johanseto
Copy link
Collaborator

@johanseto johanseto commented May 20, 2025

Description

This PR adds automatic documentation of python code.
Also, add some basic documentation of the features.

Testing instructions

make docs

Open in a web browser the index.html generated file.
docs/build/html/index.html

After

  • Check the contents section is a little summary of the repo.

2025-05-20_17-41

Screencast.from.20-05-25.17.42.54.webm
  • Check the api_package, is friendly documentation if the dosctring of functions and module works.
    Check validators eg
Screencast.from.20-05-25.17.43.41.webm

Additional information

Include anything else that will help reviewers and consumers understand the change.

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.
  • Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions.

Checklist for Merge

  • Tested in a remote environment
  • Updated documentation
  • Rebased master/main
  • Squashed commits

TO-DO:

Improve the documentation fixing docstrings or hints of warning in some modules.
image

@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process.

1 similar comment
@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process.

@johanseto johanseto force-pushed the jlc/add-documentation-init branch from 5069249 to 4c583e2 Compare May 20, 2025 22:53
@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process.

@johanseto johanseto force-pushed the jlc/add-documentation-init branch from 4c583e2 to 81eea62 Compare May 20, 2025 22:59
@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process.

@johanseto johanseto force-pushed the jlc/add-documentation-init branch 2 times, most recently from 81eea62 to 984918b Compare May 20, 2025 23:02
@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process.

1 similar comment
@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process.

johanseto added 2 commits May 21, 2025 10:30
chore: mini fix clean

fix: manifest.in include docs reqes
@johanseto johanseto force-pushed the jlc/add-documentation-init branch from 92eb6f1 to ba8e45c Compare May 21, 2025 15:30
@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process.

@johanseto johanseto marked this pull request as ready for review May 21, 2025 15:35
@johanseto johanseto requested a review from andrey-canon May 21, 2025 15:35
Copy link
Collaborator

@andrey-canon andrey-canon left a comment

Choose a reason for hiding this comment

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

I checked the description pr and I like the result, however, there is a misunderstanding since the idea is to generate automatic documentation but in the documentation repo

@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process.

@johanseto johanseto force-pushed the jlc/add-documentation-init branch from cee0855 to e22500c Compare May 21, 2025 22:35
@github-actions
Copy link

This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process.

@johanseto
Copy link
Collaborator Author

johanseto commented May 22, 2025

I checked the description pr and I like the result, however, there is a misunderstanding since the idea is to generate automatic documentation but in the documentation repo

@andrey-canon I was thinking about integrating this proposal in another way. Please check it and give me your opinion.

https://github.com/nelc/edunext-nelp-documentation/pull/21

In that way, I think all the auto-documentation, at least of docstring, would be updated in the main documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants