mustafa-tariqk / mindscape

Experience the truth of the trip
https://research.cs.queensu.ca/home/cisc498/index.html
MIT License
16 stars 0 forks source link

Pydoc #37

Closed mustafa-tariqk closed 7 months ago

mustafa-tariqk commented 7 months ago

What does this PR do?

Made a script that generates documentation for all python files in the server directory, stored in server/docs (the same will have to be done for the frontent in client/docs) @IbDaGib @ComeOnConMan

Github Issue Number

Resolves: None

Relates to: None

Author checklist

If any of these points have yet to be satisfied, make sure that you set the title to the format DRAFT #issue-num Title

Reviewer checklist

mustafa-tariqk commented 7 months ago

I'm gonna say something here @BasicallyOk

I'm making a scripts directory, we're gonna populate this with bash scripts in the next sprint. They will be used in our github actions so the action just calls the script instead of writing bash in the action

mustafa-tariqk commented 7 months ago

also: pydoc and jsdoc only output to html, hence why i'm not putting this stuff on the wiki