Merge pull request #65 from jemissik/release-updates

Release updates for v1.1.0rc3
bohrer-lab · Mar 14, 2023 · 45532fb · 45532fb
2 parents 94f3719 + c5115da
commit 45532fb
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 15 deletions.
diff --git a/apps/animator.mlapp b/apps/animator.mlapp
diff --git a/docs/conf.py b/docs/conf.py
@@ -82,6 +82,3 @@
 # matlab_src_dir = os.path.abspath(os.path.join(this_dir, '..'))
 # primary_domain = 'mat'
 
-html_theme_options = {
-    "external_links": [("Github", "https://github.com/jemissik/movebank_vis")]
-}
diff --git a/docs/developer_guide.md b/docs/developer_guide.md
@@ -16,8 +16,18 @@ for these pages are located in the [docs folder](https://github.com/jemissik/mov
 
 ### Building the docs
 After editing the pages, you can look at a build of the pages to see how things will actually look in the docs website. There are two options for this:
-- Option 1: [Open a pull request](https://github.com/jemissik/movebank_vis/pulls), and Read the Docs will build a preview of the docs pages. A link to the build can be found near the bottom of the page of the PR, in the merge checks section (once the build is finished, click on "Details" for the docs/readthedocs.org:ecodata-animate item.
-You may have to click "Show details" next to where it says "All checks have passed"). You can push additional commits to the open PR if you want to change anything after seeing the preview build.
+- Option 1: [Open a pull request](https://github.com/jemissik/movebank_vis/pulls), and Read the Docs will build a preview of the docs pages. A link to the build can be found near the bottom of the page of the PR, in the merge checks section. You may have to click "Show details" next to where it says "All checks have passed".  Once the build is finished, click on "Details" for the docs/readthedocs.org:ecodata-animate item:
+  ![rtd_status_check](images/github_status_checks.png)
+
+  This will take you to the build for the PR. Once the build is finished, click on the "View docs" link to the right of build info:
+
+  ![view_rtd_build](images/rtd_build.png)
+
+  Note that the large green "View docs" button at the top of the page takes you to the current docs page, not the PR build. When viewing the docs build for a PR, you should see a banner at the top of the docs pages that looks like this:
+  ![rtd_pr_banner](images/rtd_pr_version_warning.png)
+
+  You can push additional commits to the open PR if you want to change anything after seeing the preview build. Read the docs will build a new preview whenever a new commit is made to the PR.
+
 - Option 2: Build the docs locally. You will need to have python and the docs requirements installed.
 
     - To install the doc requirements: ``pip install sphinx furo sphinxcontrib-matlabdomain myst-parser`` or install

diff --git a/docs/examples.rst b/docs/examples.rst
diff --git a/docs/images/github_status_checks.png b/docs/images/github_status_checks.png
diff --git a/docs/images/rtd_build.png b/docs/images/rtd_build.png
diff --git a/docs/images/rtd_pr_version_warning.png b/docs/images/rtd_pr_version_warning.png
diff --git a/docs/matlab_functions.rst b/docs/matlab_functions.rst
diff --git a/docs/user_guide/index.md b/docs/user_guide/index.md
@@ -3,7 +3,7 @@
 ECODATA-Animate is a MATLAB® program for creating customized animated maps of animal movements. The program creates image frames that can be animated using the [ECODATA-Prepare Movie Maker App](https://ecodata-apps.readthedocs.io/en/latest/user_guide/movie_maker.html).
 
 ```{Tip}
-This user guide can also be downloaded for offline use! Click the version flyout menu (at the bottom of the left sidebar). Under ``Downloads``, you can choose to download the documentation in PDF, Epub, or zipped HTML format.
+This user guide can also be downloaded for offline use! [Click here](https://readthedocs.org/projects/ecodata-animate/downloads/) to download the documentation in PDF, Epub, or zipped HTML format.
 ```
 
 ## Installation

diff --git a/docs/user_guide/user_guide.md b/docs/user_guide/user_guide.md
@@ -51,7 +51,8 @@ Here you can optionally select shapefiles to display in your animation frames. T
 - Polygons: Select a color for polygon outlines (``Edge color``) and fill (``Face color``), and define the fill transparency (``Face opacity``, 1 = fully opaque).
 - Lines: Select a line color and width.
 - Points: Select a color, marker style, and marker size.
-You can choose from the default colors in the dropdown box, or enter a custom color using a hexadecimal color value (e.g., “#97d2f0”), which you can choose using a color picker like [this one](https://htmlcolorcodes.com/color-picker/) or by identifying the color value in other files using graphics or mapping software.
+
+    You can choose from the default colors in the dropdown box, or enter a custom color using a hexadecimal color value (e.g., “#97d2f0”), which you can choose using a color picker like [this one](https://htmlcolorcodes.com/color-picker/) or by identifying the color value in other files using graphics or mapping software.
 3. Repeat steps 1 and 2 to add additional shapefile layers, if desired.
 4. If you want to remove shapefiles you have entered, you can click ``Clear all shapefiles`` to remove all of them, or ``Clear last shapefile`` to clear just the last one that was entered.