-
Notifications
You must be signed in to change notification settings - Fork 0
Add documents for MkDocs website integration #46
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
base: main
Are you sure you want to change the base?
Conversation
burgess01
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inside of this PR you are trying to push multiple .DS_Store files. Please delete these, they should never be pushed to the main branch. Once those two files are removed we can look more in depth at the content of this PR. Thanks!
Thanks for reviewing this PR @burgess01. In addition to removing these files, I will add that we should try to avoid committing the files generated by MKdocs and instead include steps in GitHub actions to do that automatically after changes are pushed to main branch |
|
Suggested edit: diff --git a/Sheetshuttle_Doc/docs/index.md b/Sheetshuttle_Doc/docs/index.md
new file mode 100644
index 0000000..1b6363b
--- /dev/null
+++ b/Sheetshuttle_Doc/docs/index.md
@@ -0,0 +1,19 @@
+# my
+
+#### Welcome to SheetShuttle API Reference Documentation
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+ mkdocs.yml # The configuration file.
+ docs/ls
+ index.md # The documentation homepage.
+ ... # Other markdown pages, images and other files.
diff --git a/Sheetshuttle_Doc/mkdocs.yml b/Sheetshuttle_Doc/mkdocs.yml
new file mode 100644
index 0000000..d248e7e
--- /dev/null
+++ b/Sheetshuttle_Doc/mkdocs.yml
@@ -0,0 +1,6 @@
+site_name: Sheet~shuttle API Reference Documentation
+site url: https://SheetShuttle.github.io
+nav:
+ - Home: index.md
+
+
|
This pull request provides the documents needed to deploy a documentation website. We hope to implement automated API documentation in the future and are looking for further insight into how we may do this.