Skip to content

Commit

Permalink
Rename XRP_Micropython to XRPLib in Readme and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ksiegall committed Aug 23, 2023
1 parent d536c9a commit 88fb486
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 14 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Getting Starting with your XRP Robot
# Welcome to XRPLib!!!

## Getting Starting with your XRP Robot

### Step 1: Plug XRP Robot Controller Board into Computer

Expand Down
22 changes: 11 additions & 11 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
master_doc = "index"

# General information about the project.
project = "MicroPython XRP Library"
project = "XRPLib - MicroPython"
creation_year = "2023"
current_year = str(datetime.datetime.now().year)
year_duration = (
Expand Down Expand Up @@ -153,7 +153,7 @@
html_favicon = "_static/xrplogo.ico"

# Output file base name for HTML help builder.
htmlhelp_basename = "MicroPython_XRP_Library_Doc"
htmlhelp_basename = "MicroPython_XRPLib_Doc"

# -- Options for LaTeX output ---------------------------------------------

Expand All @@ -174,8 +174,8 @@
latex_documents = [
(
master_doc,
"MicroPython_XRP_Library.tex",
"MicroPython XRP Library Documentation",
"MicroPython_XRPLib.tex",
"MicroPython XRPLib Documentation",
author,
"manual",
),
Expand All @@ -188,8 +188,8 @@
man_pages = [
(
master_doc,
"MicroPython_XRP_Library",
"MicroPython XRP Library Documentation",
"MicroPython_XRPLib",
"MicroPython XRPLib Documentation",
[author],
1,
),
Expand All @@ -203,11 +203,11 @@
texinfo_documents = [
(
master_doc,
"MicroPython_XRP_Library",
"MicroPython XRP Library Documentation",
"MicroPython_XRPLib",
"MicroPython XRPLib Documentation",
author,
"MicroPython_XRP_Library",
"One line description of project.",
"Miscellaneous",
"MicroPython_XRPLib",
"The API Documentation for XRPLib",
"Robotics",
),
]
5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,14 @@ Table of Contents
:caption: Curriculum

XRP Curriculum <https://introtoroboticsv2.readthedocs.io>
XRP User Guide <https://xrpusersguide.readthedocs.io/en/latest/course/introduction.html>
XRPLib on GitHub <https://github.com/Open-STEM/XRP_MicroPython/releases/latest>
XRP Support Forum <https://xrp.discourse.group>

.. toctree::
:caption: Other Links

XRP_MicroPython on GitHub <https://github.com/Open-STEM/XRP_MicroPython/releases/latest>
Download Micropython <https://micropython.org/download/>
Download MicroPython <https://micropython.org/download/>
MicroPython Reference Documentation <https://docs.micropython.org/en/latest/>
MicroPython Support Forum <https://github.com/orgs/micropython/discussions>

Expand Down

0 comments on commit 88fb486

Please sign in to comment.