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

docs: adds docs tool, material for mkdocs, along with more fleshed ou… #428

Merged
merged 5 commits into from
Jan 5, 2024

Conversation

jaydrennan
Copy link
Collaborator

…t docstrings.

this includes ability to serve up a local docs website.

Copy link
Owner

@brycedrennan brycedrennan left a comment

Choose a reason for hiding this comment

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

Delete most the stuff chatgpt made. It highlights unimportant details.

@jaydrennan jaydrennan force-pushed the materials_for_mkdocs branch 5 times, most recently from e464197 to c8012e4 Compare December 27, 2023 06:25
Copy link
Owner

Choose a reason for hiding this comment

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

Lets make a new more interesting image and use it here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Replaced it with something different, but not necessarily better.

@brycedrennan
Copy link
Owner

make docs

mkdocs serve
make: mkdocs: No such file or directory
make: *** [docs] Error 1

@jaydrennan
Copy link
Collaborator Author

Delete most the stuff chatgpt made. It highlights unimportant details.

I believe this has been completed.

@jaydrennan
Copy link
Collaborator Author

make docs

mkdocs serve
make: mkdocs: No such file or directory
make: *** [docs] Error 1

This is probably because I didn't add necessary pip requirements.

@jaydrennan jaydrennan force-pushed the materials_for_mkdocs branch 2 times, most recently from 3395c42 to ee205ee Compare January 2, 2024 03:42
@brycedrennan
Copy link
Owner

mkdocs serve
ERROR   -  Config value 'plugins': The "mkdocstrings" plugin is not installed

Aborted with 1 configuration errors!
make: *** [docs] Error 1

@jaydrennan jaydrennan force-pushed the materials_for_mkdocs branch from ee205ee to 84a87f0 Compare January 3, 2024 03:49
@jaydrennan
Copy link
Collaborator Author

mkdocs serve
ERROR   -  Config value 'plugins': The "mkdocstrings" plugin is not installed

Aborted with 1 configuration errors!
make: *** [docs] Error 1

Missed a package. They're all there now.

@jaydrennan jaydrennan force-pushed the materials_for_mkdocs branch 4 times, most recently from 405b36d to a48ff94 Compare January 4, 2024 04:40
…t docstrings.

this includes ability to serve up a local docs website.
@jaydrennan jaydrennan force-pushed the materials_for_mkdocs branch from a48ff94 to d50c445 Compare January 4, 2024 04:51
@jaydrennan jaydrennan merged commit 89bc1a9 into master Jan 5, 2024
@jaydrennan jaydrennan deleted the materials_for_mkdocs branch January 5, 2024 05:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants