add docs

Author: brentru

README.rst

@@ -69,7 +69,7 @@ Usage Example
 =============
 
 To obtain an OpenWeatherMaps API key, sign up for a free account at `OpenWeatherMaps <https://openweathermap.org/>`_ and generate an API key. Then, in the root of this
-project, add a file called `settings.toml` with the following information:
+project, add a file called "settings.toml" with the following information:
 
 openweather_token = "my_api_key"
 openweather_location = "New York, US"

docs/api.rst

@@ -4,5 +4,8 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
-.. automodule:: circuitpython_fake_bme280
+API
+=================
+
+.. automodule:: fake_bme280
     :members:

docs/conf.py

@@ -49,7 +49,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = "CircuitPython CircuitPython Fake BME280 Library"
+project = "CircuitPython Fake BME280 Library"
 creation_year = "2024"
 current_year = str(datetime.datetime.now().year)
 year_duration = (
@@ -129,7 +129,7 @@
 html_favicon = "_static/favicon.ico"
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "CircuitPython_Circuitpython_fake_bme280_Librarydoc"
+htmlhelp_basename = "Circuitpython_fake_bme280_Librarydoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -150,8 +150,8 @@
 latex_documents = [
     (
         master_doc,
-        "CircuitPython_CircuitPython_Fake_BME280_Library.tex",
-        "CircuitPython CircuitPython Fake BME280 Library Documentation",
+        "CircuitPython_Fake_BME280_Library.tex",
+        "CircuitPython Fake BME280 Library Documentation",
         author,
         "manual",
     ),
@@ -164,8 +164,8 @@
 man_pages = [
     (
         master_doc,
-        "CircuitPython_CircuitPython_Fake_BME280_Library",
-        "CircuitPython CircuitPython Fake BME280 Library Documentation",
+        "CircuitPython_Fake_BME280_Library",
+        "CircuitPython Fake BME280 Library Documentation",
         [author],
         1,
     ),
@@ -179,10 +179,10 @@
 texinfo_documents = [
     (
         master_doc,
-        "CircuitPython_CircuitPython_Fake_BME280_Library",
-        "CircuitPython CircuitPython Fake BME280 Library Documentation",
+        "CircuitPython_Fake_BME280_Library",
+        "CircuitPython Fake BME280 Library Documentation",
         author,
-        "CircuitPython_CircuitPython_Fake_BME280_Library",
+        "CircuitPython_Fake_BME280_Library",
         "One line description of project.",
         "Miscellaneous",
     ),

docs/examples.rst

@@ -3,6 +3,6 @@ Simple test
 
 Ensure your device works with this simple test.
 
-.. literalinclude:: ../examples/circuitpython_fake_bme280_simpletest.py
-    :caption: examples/circuitpython_fake_bme280_simpletest.py
+.. literalinclude:: ../examples/fake_bme280_simpletest.py
+    :caption: examples/fake_bme280_simpletest.py
     :linenos:

docs/index.rst

@@ -24,19 +24,14 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
 
 .. toctree::
     :caption: Other Links
 
-    Download from GitHub <https://github.com/brentru/CircuitPython_CircuitPython_Fake_BME280/releases/latest>
+    Download from GitHub <https://github.com/adafruit/Adafruit_CircuitPython_Fake_BME280/releases/latest>
     Download Library Bundle <https://circuitpython.org/libraries>
     CircuitPython Reference Documentation <https://docs.circuitpython.org>
     CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>