tlang
/
tpkg
mirror of https://github.com/tbklang/tpkg
1
0
Fork 0
Code Issues 2 Packages Projects 1 Releases Wiki Activity

Documentation generation #2

New Issue
Closed
opened 2024-04-15 10:45:42 +01:00 by deavmi · 13 comments
deavmi commented 2024-04-15 10:45:42 +01:00
Owner
Copy Link

Purpose ✍️

To add a document generator.

Checklist

  • Command-line support with tpkg docgen [path]
  • Pages
## Purpose ✍️ To add a document generator. ## Checklist - [x] Command-line support with `tpkg docgen [path]` - [x] Pages
deavmi added reference master 2024-04-15 10:45:45 +01:00
deavmi self-assigned this 2024-04-15 10:45:54 +01:00
deavmi added a new dependency 2024-04-15 10:49:50 +01:00
#1 Project and package management
deavmi started working 2024-04-15 10:54:18 +01:00
deavmi stopped working 2024-04-15 11:06:21 +01:00
12 minutes 3 seconds
deavmi started working 2024-04-15 12:54:52 +01:00
deavmi commented 2024-04-15 12:54:58 +01:00
Author
Owner
Copy Link

Working on this again now...

Working on this again now...
deavmi commented 2024-04-15 12:59:47 +01:00
Author
Owner
Copy Link

It works!

image

It works! ![image](/attachments/6863af3a-4086-480a-addf-19a756c7a30c)
image.png
75 KiB
deavmi commented 2024-04-15 13:12:59 +01:00
Author
Owner
Copy Link

Heh, I thought there was a reason for keeping the module's file path around:

image

Heh, I thought there was a reason for keeping the module's file path around: ![image](/attachments/4e458b02-a909-4bb0-99f8-1e882c0bc697)
image.png
66 KiB
deavmi commented 2024-04-15 16:44:06 +01:00
Author
Owner
Copy Link

Program frontpage

Given a Program this will show all the Module(s) it is made up of:

image

Module page

This shows all the functions declared and available inside of a given Module:

image

### Program frontpage Given a `Program` this will show all the `Module`(s) it is made up of: ![image](/attachments/3d932ac9-09e1-4dee-86d2-9b44adef5a11) ### Module page This shows all the functions declared and available inside of a given `Module`: ![image](/attachments/83a7ce73-9923-42e0-abea-b6911601de48)
image.png
64 KiB
image.png
24 KiB
deavmi commented 2024-04-15 16:50:58 +01:00
Author
Owner
Copy Link

@tlang/Owners Help

@tlang/Owners Help
deavmi stopped working 2024-04-15 17:09:57 +01:00
4 hours 15 minutes
deavmi started working 2024-04-15 17:13:47 +01:00
deavmi commented 2024-04-15 17:21:55 +01:00
Author
Owner
Copy Link

Okay now we're cooking:

image
image

Okay **now** we're cooking: ![image](/attachments/ed3002ef-a802-4ead-97d2-a3c88b9c21d1) ![image](/attachments/f0d70b3f-3bfd-4cf6-9dbb-c41a8749a936)
image.png
96 KiB
image.png
114 KiB
deavmi stopped working 2024-04-15 17:39:39 +01:00
25 minutes 52 seconds
deavmi added spent time 2024-04-15 17:53:33 +01:00
5 minutes
deavmi started working 2024-04-15 17:53:36 +01:00
deavmi stopped working 2024-04-15 18:12:14 +01:00
18 minutes 38 seconds
deavmi started working 2024-04-15 18:43:25 +01:00
deavmi commented 2024-04-15 19:05:45 +01:00
Author
Owner
Copy Link

Looking good! Now with a parameter table!

image

Looking good! Now with a parameter table! ![image](/attachments/fee53ac6-bdb1-4333-b350-6c5f0c140fa0)
image.png
42 KiB
deavmi stopped working 2024-04-15 19:21:57 +01:00
38 minutes 33 seconds
deavmi added spent time 2024-04-16 07:36:47 +01:00
6 minutes
deavmi commented 2024-04-16 18:02:18 +01:00
Author
Owner
Copy Link

Look at that, doc string parsing!

image

Look at that, doc string parsing! ![image](/attachments/9bbcfff1-f142-48ad-a4a3-69672c5e0d7b)
image.png
105 KiB
deavmi commented 2024-04-19 22:59:19 +01:00
Author
Owner
Copy Link

Did some work on the command-line tooling side for docgen now, going to sleep now though

Did some work on the command-line tooling side for `docgen` now, going to sleep now though
deavmi added spent time 2024-04-19 22:59:35 +01:00
15 minutes
deavmi added spent time 2024-04-20 17:57:26 +01:00
10 minutes
deavmi started working 2024-04-20 17:57:29 +01:00
deavmi stopped working 2024-04-20 17:58:19 +01:00
50 seconds
deavmi added this to the Basic milestone 2024-04-20 17:58:39 +01:00
deavmi started working 2024-04-20 19:19:02 +01:00
deavmi commented 2024-04-20 19:19:08 +01:00
Author
Owner
Copy Link

Commands

  • Document generation on command line now works
Commands - Document generation on command line now works
deavmi added the
enhancement
 label 2024-04-20 19:22:31 +01:00
deavmi stopped working 2024-04-20 20:10:01 +01:00
50 minutes 59 seconds
deavmi added spent time 2024-04-20 20:55:50 +01:00
1 minute
deavmi added spent time 2024-04-22 11:29:28 +01:00
3 minutes
deavmi started working 2024-04-22 11:29:30 +01:00
deavmi added the due date 2024-04-30 2024-04-22 11:29:35 +01:00
deavmi commented 2024-04-22 11:29:43 +01:00
Author
Owner
Copy Link

Polishing the document generation now

Polishing the document generation now
deavmi commented 2024-04-22 11:35:01 +01:00
Author
Owner
Copy Link

I think for now this is okay.

I think for now this is okay.
deavmi added this to the General project 2024-04-22 11:35:35 +01:00
deavmi commented 2024-04-22 11:35:54 +01:00
Author
Owner
Copy Link

Done ✅

Done ✅
deavmi stopped working 2024-04-22 11:35:57 +01:00
6 minutes 27 seconds
deavmi removed a dependency 2024-04-22 11:36:06 +01:00
#1 Project and package management
Sign in to join this conversation.
master
Branches Tags
Clear current reference
master
Clear current reference
Labels
Clear labels   
bug

Something is not working

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
help wanted

Need some help

  
invalid

Something is wrong

  
question

More information is needed

  
wontfix

This won't be fixed

No Label
bug
duplicate
enhancement
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No Milestone
Basic
Projects
Clear projects
No project
General
Assignees
Clear assignees
No Assignees
deavmi
1 Participants
Notifications
Total Time Spent: 7 hours 28 minutes
deavmi
7 hours 28 minutes
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

2024-04-30

Dependencies

No dependencies set.

Reference: tlang/tpkg#2
No description provided.
Delete Branch "%!s(<nil>)"

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?