Skip to content
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

Organize LAMBKIN documentation #18

Open
2 of 4 tasks
hidmic opened this issue Mar 1, 2022 · 2 comments
Open
2 of 4 tasks

Organize LAMBKIN documentation #18

hidmic opened this issue Mar 1, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation needs-work Ready to be worked on

Comments

@hidmic
Copy link
Collaborator

hidmic commented Mar 1, 2022

Description

Thanks to https://github.com/ekumenlabs/RnD/issues/83, lambkin has some documentation, but there's none about lambkin moving parts (split across technologies) nor there's a policy to keep things easily accessible.

We need to improve this. Likely depends on #17.

Definition of Done

  • Use Sphinx to generate lambkin project documentation
  • Make existing documentation available to Sphinx
  • Revisit Python codebase, make sure docstrings are in place
  • Figure out how to document RobotFramework extensions
@hidmic hidmic added the documentation Improvements or additions to documentation label Mar 1, 2022
@hidmic
Copy link
Collaborator Author

hidmic commented Mar 1, 2022

One important bit that I purposefully kept out: we should build and deploy such documentation to Github Pages (assuming that project pages can be generated in our current tier).

@gonzodepedro gonzodepedro self-assigned this Nov 3, 2022
@hidmic hidmic mentioned this issue Apr 12, 2023
6 tasks
@hidmic hidmic added the needs-work Ready to be worked on label Apr 12, 2023
@hidmic hidmic changed the title Organize lambkin documentation Organize LAMBKIN documentation Apr 18, 2023
@hidmic
Copy link
Collaborator Author

hidmic commented Apr 18, 2023

This should probably wait for #44.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs-work Ready to be worked on
Projects
None yet
Development

No branches or pull requests

2 participants