improve docs

darenr · Jan 10, 2025 · d9af9ff · d9af9ff
1 parent cf2a412
commit d9af9ff
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -31,19 +31,28 @@
 
 myst_enable_extensions = [
     "amsmath",
+    "attrs_inline",
+    "attrs_block",
     "colon_fence",
     "deflist",
     "dollarmath",
     "fieldlist",
     "html_admonition",
     "html_image",
+    # "linkify",
     "replacements",
     "smartquotes",
     "strikethrough",
     "substitution",
     "tasklist",
 ]
 
+# Copy button settings
+copybutton_prompt_text = "$ "  # for bash prompts
+copybutton_prompt_is_regexp = False
+copybutton_remove_prompts = True
+copybutton_line_continuation_character = "\\"
+
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 

diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -11,7 +11,11 @@ To use ``report_creator``, first install it using pip:
 .. admonition:: Installation
    :class: note
 
-   $ pip install report_creator -U
+   To install the package, run:
+
+   .. code-block:: bash
+
+      $ python -m pip install report_creator -U
 
 Example Usage
 -------------

diff --git a/report_creator/__version__.py b/report_creator/__version__.py
@@ -1 +1 @@
-__version__ = "1.0.37"
+__version__ = "1.0.38"