Merge pull request #5 from boilerrobotics/jupiyer-book

edit github action

.github/workflows/deploy.yml

@@ -38,13 +38,13 @@ jobs:
       # Build the book
       - name: Build the book
         run: |
-          jupyter-book build knowledge
+          jupyter-book build inscription
 
       # Upload the book's HTML as an artifact
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
-          path: "_build/html"
+          path: "inscription/_build/html"
 
       # Deploy the book's HTML to GitHub Pages
       - name: Deploy to GitHub Pages

.gitignore

@@ -0,0 +1 @@
+_build

CONTRIBUTING.md

@@ -25,8 +25,8 @@ and "help wanted" is open to whoever wants to implement it.
 
 ## Write Documentation
 
-knowledge could always use more documentation, whether as part of the
-official knowledge docs, in docstrings, or even on the web in blog posts,
+inscription could always use more documentation, whether as part of the
+official inscription docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 ## Submit Feedback
@@ -42,7 +42,7 @@ If you are proposing a feature:
 
 ## Get Started
 
-Ready to contribute? Here's how to set up `knowledge` for local development.
+Ready to contribute? Here's how to set up `inscription` for local development.
 
 1. Fork the repo on GitHub.
 2. Clone your fork locally.
@@ -53,4 +53,4 @@ Ready to contribute? Here's how to set up `knowledge` for local development.
 
 ## Code of Conduct
 
-Please note that the knowledge project is released with a [Contributor Code of Conduct](CONDUCT.md). By contributing to this project you agree to abide by its terms.
+Please note that the inscription project is released with a [Contributor Code of Conduct](CONDUCT.md). By contributing to this project you agree to abide by its terms.

README.md

@@ -1,20 +1,20 @@
-# knowledge
+# inscription
 
-This is knowledge book for Boiler Robotics Club
+Knowledge center for Boiler Robotics club
 
 ## Usage
 
 ### Building the book
 
-If you'd like to develop and/or build the knowledge book, you should:
+If you'd like to develop and/or build the inscription book, you should:
 
 1. Clone this repository
 2. Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
-3. (Optional) Edit the books source files located in the `knowledge/` directory
-4. Run `jupyter-book clean knowledge/` to remove any existing builds
-5. Run `jupyter-book build knowledge/`
+3. (Optional) Edit the books source files located in the `inscription/` directory
+4. Run `jupyter-book clean inscription/` to remove any existing builds
+5. Run `jupyter-book build inscription/`
 
-A fully-rendered HTML version of the book will be built in `knowledge/_build/html/`.
+A fully-rendered HTML version of the book will be built in `inscription/_build/html/`.
 
 ### Hosting the book
 
@@ -24,7 +24,7 @@ For GitHub and GitLab deployment specifically, the [cookiecutter-jupyter-book](h
 
 ## Contributors
 
-We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/tame0001/knowledge/graphs/contributors).
+We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/boilerrobotics/inscription/graphs/contributors).
 
 ## Credits
 

knowledge/_config.yml → inscription/_config.yml

@@ -1,14 +1,14 @@
 #######################################################################################
 # A default configuration that will be loaded for all jupyter books
-# See the documentation for help and more options:
+# See the documentation for help and more options: 
 # https://jupyterbook.org/customize/config.html
 
 #######################################################################################
 # Book settings
-title: knowledge # The title of the book. Will be placed in the left navbar.
-author: Tam Bureetes # The author of the book
-copyright: "2024" # Copyright year to be placed in the footer
-logo: logo.png # A path to the book logo
+title                       : inscription  # The title of the book. Will be placed in the left navbar.
+author                      : Boiler Robotics Club  # The author of the book
+copyright                   : "2024"  # Copyright year to be placed in the footer
+logo                        : logo.png  # A path to the book logo
 
 # Force re-execution of notebooks on each build.
 # See https://jupyterbook.org/content/execute.html
@@ -26,12 +26,12 @@ bibtex_bibfiles:
 
 # Information about where the book exists on the web
 repository:
-  url: https://github.com/boilerrobotics/on-boarding # Online location of your book
-  path_to_book: docs # Optional path to your book, relative to the repository root
-  branch: main # Which branch of the repository should be used when creating links (optional)
+  url: https://github.com/boilerrobotics/inscription  # Online location of your book
+  path_to_book: docs  # Optional path to your book, relative to the repository root
+  branch: main  # Which branch of the repository should be used when creating links (optional)
 
 # Add GitHub buttons to your book
 # See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
 html:
   use_issues_button: true
-  use_repository_button: true
+  use_repository_button: true

requirements.txt

@@ -1 +1,4 @@
-jupyter-book==1.0.*
+jupyter-book
+matplotlib
+numpy
+ghp-import