Minor documentation update

PolusAI · May 30, 2024 · 8aee7a4 · 8aee7a4
1 parent 98ffaf3
commit 8aee7a4
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -11,19 +11,15 @@ a directory containing segmented images where the name contains information such
 extract all images containing such a naming pattern, filter by the row or column value, or group files by one or more of the aforementioned variables.
 
 ## Summary
-- [Read the Docs](https://filepattern2.readthedocs.io/en/latest/Home.html)
+- [Read the Docs](https://filepattern.readthedocs.io/en/latest/Home.html)
 - [Install](#install)
 - [Authors](#authors)
 - [License](#license)
 - [Acknowledgments](#acknowledgments)
 
 ## Install
 
-`filepattern` is pip installable from https://pypi.org/project/filepattern/.
-
-or by running
-
-pip install -i https://pypi.org/simple/ filepattern
+`filepattern` is both pip and conda installable by running `pip install filepattern` or `conda install filepattern -c conda-forge`
 
 ## Build and Install
 Alternatively, ``filepattern`` can either be build inside a `conda` environment or independently outside of it directly from the source.

diff --git a/docs/source/Home.rst b/docs/source/Home.rst
@@ -19,7 +19,7 @@ not limited to image data, and can handle filenames with any extension.
    :maxdepth: 3
    :caption: Contents:
 
-   Examples
+   Python
    Java
    Reference
    Backend
diff --git a/docs/source/Examples.rst → docs/source/Python.rst b/docs/source/Examples.rst → docs/source/Python.rst
@@ -1,5 +1,5 @@
 ========
-Examples
+Python API
 ========
 
 FilePattern iterates over a directory, text file, or stitching vector, matching filenames to a supplied ``filepattern``.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -2,7 +2,7 @@
 Filepattern: A Utility for Programmatic File Manipulation
 =========================================================
 
-The ``filepattern`` Python utility is designed to extract information stored in
+The ``filepattern`` utility is designed to extract information stored in
 file names. A ``filepattern`` is essentially a simplified regular expression with
 named groups, and regular expressions are valid ``filepattern`` expressions
 provided they do not use groups.
@@ -19,6 +19,7 @@ not limited to image data, and can handle filenames with any extension.
    :maxdepth: 3
    :caption: Contents:
 
-   Examples
+   Python
+   Java
    Reference
    Backend