Skip to content

Conversation

@ningerson2002
Copy link
Collaborator

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.

Copy link
Collaborator

@burgess01 burgess01 left a 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!

@noorbuchi
Copy link
Collaborator

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

@BillOchieng
Copy link
Collaborator

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
+   
+

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.

7 participants