Docs (#21)

* ignore ruff dir

* typo

* clean up

* clean up

Author: steveberardi

.gitignore

@@ -3,6 +3,9 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+# ruff
+.ruff_cache
+
 # C extensions
 *.so
 
@@ -69,19 +72,6 @@ coverage.xml
 *.mo
 *.pot
 
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
 # Sphinx documentation
 docs/_build/
 
@@ -108,13 +98,6 @@ ipython_config.py
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow
 __pypackages__/
 
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
 # Environments
 .env
 .venv

Makefile

@@ -77,6 +77,7 @@ clean:
 	rm -rf __pycache__
 	rm -rf venv
 	rm -rf dist
+	rm -rf site
 	rm -rf htmlcov
 
 .PHONY: install shell build publish clean example

docs/examples.md

@@ -53,7 +53,7 @@ p = sp.ZenithPlot(
     resolution=2000,
 )
 p.plot_object(
-    SkyObject(
+    sp.SkyObject(
         name="Mel 111",
         ra=12.36,
         dec=25.85,
@@ -88,7 +88,7 @@ style = sp.styles.MAP_BLUE.extend(
 style.star.label.font_size = 11
 
 p = sp.MapPlot(
-    projection=Projection.MERCATOR,
+    projection=sp.Projection.MERCATOR,
     ra_min=3.6,
     ra_max=7.8,
     dec_min=-16,
@@ -98,7 +98,7 @@ p = sp.MapPlot(
     resolution=4000,
 )
 p.plot_object(
-    SkyObject(
+    sp.SkyObject(
         name="M42",
         ra=5.58333,
         dec=-4.61,

docs/tutorial.md

@@ -17,14 +17,14 @@ nav:
 theme:
   name: material
   palette:
-    # Palette toggle for light mode
+    # toggle for light mode
     - scheme: default
       primary: custom
       toggle:
         icon: material/brightness-7 
         name: Switch to dark mode
 
-    # Palette toggle for dark mode
+    # toggle for dark mode
     - scheme: slate
       primary: custom
       toggle:
@@ -34,7 +34,6 @@ theme:
   favicon: images/favicon.png
   features:
     - content.code.copy
-    # - navigation.expand
     - toc.integrate
 
 extra_css:
@@ -51,8 +50,6 @@ plugins:
             docstring_section_style: list
 
 markdown_extensions:
-  # - toc:
-  #     permalink: true
   - admonition
   - md_in_html
   - pymdownx.highlight: