expo/troggle
2
0
Fork 1
mirror of https://expo.survex.com/repositories/troggle/.git synced 2025-02-17 04:30:13 +00:00
Code Issues 18 Projects 3 Activity

Implement Self-Documentation #8

New Issue
Open
opened 2023-08-02 16:10:42 +01:00 by xle · 0 comments
xle commented 2023-08-02 16:10:42 +01:00
Owner
Copy Link

Python has two very good packages for writing self-documenting code:

MkDocs being less fully-featured but easier to implement.

I would suggest we integrate such a package for Troggle to auto-generate some HTML files that detail important things like the models structure.

Python has two very good packages for writing self-documenting code: - Sphinx: https://www.sphinx-doc.org/en/master/ - MkDocs: https://www.mkdocs.org/ MkDocs being less fully-featured but easier to implement. I would suggest we integrate such a package for Troggle to auto-generate some HTML files that detail important things like the models structure.
xle added the
Enhancement
Low Priority
Minor Change
 labels 2023-08-02 16:10:42 +01:00
xle added this to the Back-end Enhancements project 2023-08-02 16:10:42 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Bug
Bug - something that doesn't work as it should do
Enhancement
New feature or enhancement
High Priority
Critical issue. Fix/implement ASAP
Low Priority
Non-critical issue, nice-to-haves etc.
Major Change
Change of large scope
Minor Change
Change of small scope
No Label
Enhancement
Low Priority
Minor Change
Milestone
No items
No Milestone
Projects
Clear projects
No project Back-end Enhancements
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: expo/troggle#8
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?