Deployed 9223f1e with MkDocs version: 1.5.3

Atlas-B2023 · Dec 6, 2023 · 90e285f · 90e285f
1 parent c641d92
commit 90e285f
Show file tree

Hide file tree

Showing 11 changed files with 5,676 additions and 6,130 deletions.
diff --git a/backend/helper/index.html b/backend/helper/index.html
diff --git a/backend/redfinscraper/index.html b/backend/redfinscraper/index.html
diff --git a/backend/secondarydata/index.html b/backend/secondarydata/index.html
diff --git a/gen_ref_pages.py b/gen_ref_pages.py
@@ -4,7 +4,6 @@
 from pathlib import Path
 import mkdocs_gen_files
 
-# maybe take main out later when we have the gui, but for now its not needed.
 exclude_words = ["__init__", "csv_merge", "main"]
 src_path = Path(__file__).parent.parent / "src"
 
@@ -22,64 +21,3 @@
 
     mkdocs_gen_files.set_edit_path(doc_path, path)
 
-# for path in sorted(src_path.rglob("*.py")):
-#     filename = path.with_suffix("")
-#     rel_filename = path.relative_to("src").with_suffix("")
-
-#     filename_parts = filename.parts
-
-#     if [elem for elem in exclude_words if elem in [part for part in filename_parts]]:
-#         continue
-#     print(".".join(filename_parts))
-#     with mkdocs_gen_files.open(rel_filename.with_suffix(".md"), "w") as fd:
-#         print("::: " + ".".join(filename_parts), file=fd)
-
-#     mkdocs_gen_files.set_edit_path(rel_filename.with_suffix(".md"), "gen_ref_pages.py")
-
-
-# # src_folder = "src"
-# # for path in sorted(Path("src_folder").rglob("*.py")):
-# #     md_filename = path.relative_to("src_folder").with_suffix(".md")
-# #     py_filename = path.relative_to("src_folder")
-
-# #     parts = py_filename.parts
-# #     #dont document the __init__ file in modules
-# #     if parts[-1] == "__init__":
-# #         parts = parts[:-1]
-# #     elif parts[-1] == "__main__":
-# #         continue
-
-# #     with mkdocs_gen_files.open(md_filename, "w") as fd:
-# #         # get last part and change to py
-# #         print("::: " + src_folder + ".".join(parts), file=fd)
-
-# #     mkdocs_gen_files.set_edit_path(md_filename, "gen_ref_pages.py")
-
-# # for total in range(19, 100, 20):
-# #     filename = f"sample/{total}-bottles.md"
-
-# #     with mkdocs_gen_files.open(filename, "w") as f:
-# #         for i in reversed(range(1, total + 1)):
-# #             print(f"{i} bottles of beer on the wall, {i} bottles of beer  ", file=f)
-# #             print(f"Take one down and pass it around, **{i-1}** bottles of beer on the wall\n", file=f)
-
-# #     mkdocs_gen_files.set_edit_path(filename, "gen_ref_pages.py")
-
-
-# with mkdocs_gen_files.open("src/test/RedfinSearcher.md", "w") as fd:
-#     # get last part and change to py
-#     print("::: " + "src.test.RedfinSearcher", file=fd)
-#     # print("handler: python")
-#     # print("options:")
-#     # print("members:")
-#     # print("- set_filters_path")
-#     # print("- set_filters_path")
-#     # options:
-#     #   members:
-#     #     - set_filters_path
-#     #     - generate_filters_path
-#     #   show_root_heading: false
-#     #   show_source: true
-#     #   """)
-
-# mkdocs_gen_files.set_edit_path("src/test/RedfinSearcher.md", "gen_ref_pages.py")
diff --git a/gui/datapage/index.html b/gui/datapage/index.html
diff --git a/gui/filterspage/index.html b/gui/filterspage/index.html
diff --git a/gui/searchpage/index.html b/gui/searchpage/index.html
diff --git a/index.html b/index.html
@@ -304,8 +304,15 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#atlas-iqp-b23-residential-heating-code-documentation" class="md-nav__link">
-    Atlas IQP B23 Residential Heating Code Documentation
+  <a href="#code-documentation" class="md-nav__link">
+    Code Documentation
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#program-usage" class="md-nav__link">
+    Program usage
   </a>
 
 </li>
@@ -647,8 +654,10 @@
 
 
 <h1 id="home">Home</h1>
-<h2 id="atlas-iqp-b23-residential-heating-code-documentation">Atlas IQP B23 Residential Heating Code Documentation</h2>
-<p>Public functions are documented on the left. A video series on YouTube will be uploaded soon to assist in learning about the usage of this program.</p>
+<h2 id="code-documentation">Code Documentation</h2>
+<p>Public functions are documented on the left. Additional comments for private functions are found through looking at the source code. The <code>main.py</code> file is not a part of the scraping library and just serves as a launching point for the GUI application.</p>
+<h2 id="program-usage">Program usage</h2>
+<p>A YouTube playlist is being created that walks through how to use the scraping tool. An additional set of videos on how to combine the data collected and import and analyze them in QGIS is being created as well.</p>
 
 
 

diff --git a/search/search_index.json b/search/search_index.json
diff --git a/sitemap.xml b/sitemap.xml
@@ -2,52 +2,52 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://atlas-b2023.github.io/ResidentialElectrificationTracker/</loc>
-         <lastmod>2023-11-24</lastmod>
+         <lastmod>2023-12-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://atlas-b2023.github.io/ResidentialElectrificationTracker/backend/helper/</loc>
-         <lastmod>2023-11-24</lastmod>
+         <lastmod>2023-12-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://atlas-b2023.github.io/ResidentialElectrificationTracker/backend/redfinscraper/</loc>
-         <lastmod>2023-11-24</lastmod>
+         <lastmod>2023-12-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://atlas-b2023.github.io/ResidentialElectrificationTracker/backend/secondarydata/</loc>
-         <lastmod>2023-11-24</lastmod>
+         <lastmod>2023-12-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://atlas-b2023.github.io/ResidentialElectrificationTracker/backend/us/states/</loc>
-         <lastmod>2023-11-24</lastmod>
+         <lastmod>2023-12-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://atlas-b2023.github.io/ResidentialElectrificationTracker/backend/us/unitedstatesofamerica/</loc>
-         <lastmod>2023-11-24</lastmod>
+         <lastmod>2023-12-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://atlas-b2023.github.io/ResidentialElectrificationTracker/gui/app/</loc>
-         <lastmod>2023-11-24</lastmod>
+         <lastmod>2023-12-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://atlas-b2023.github.io/ResidentialElectrificationTracker/gui/datapage/</loc>
-         <lastmod>2023-11-24</lastmod>
+         <lastmod>2023-12-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://atlas-b2023.github.io/ResidentialElectrificationTracker/gui/filterspage/</loc>
-         <lastmod>2023-11-24</lastmod>
+         <lastmod>2023-12-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://atlas-b2023.github.io/ResidentialElectrificationTracker/gui/searchpage/</loc>
-         <lastmod>2023-11-24</lastmod>
+         <lastmod>2023-12-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/sitemap.xml.gz b/sitemap.xml.gz