Add linkcheck job to CI (#43)

* Add linkcheck job to CI * Fix broken links
observational-dev · Oct 18, 2023 · dac33c8 · dac33c8
1 parent f424e5a
commit dac33c8
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 12 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -28,3 +28,22 @@ jobs:
         with:
           name: site
           path: src/_build/html/*
+
+  check-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+
+      - name: Check links
+        working-directory: src
+        run: |
+          # Set timezone to avoid issue with nektos/act
+          # https://github.com/nektos/act/issues/1853
+          TZ=UTC make linkcheck
diff --git a/src/Makefile b/src/Makefile
@@ -12,7 +12,13 @@ BUILDDIR      = _build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+.PHONY: help Makefile linkcheck
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(SOURCEDIR) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

diff --git a/src/beginning/index.md b/src/beginning/index.md
@@ -10,6 +10,6 @@ It looks like this page hasn't been written yet. Would you be willing to [help](
 
 % This line won't show up on the wiki, cuz it starts with a %. Anyway, it's here to give you some tips editing. You can delete these bits at your convenience.
 
-% The preview in GitHub will be close to how the page will look on the wiki, but not quite exact. For fomatting examples, see examplepage source and examplepage on the wiki - respectively https://github.com/observational-dev/oawiki/blob/main/src/other/examplepage.md?plain=1 and https://wiki.observational.space/other/examplepage.html
+% The preview in GitHub will be close to how the page will look on the wiki, but not quite exact. For fomatting examples, see examplepage source and examplepage on the wiki - respectively <https://github.com/observational-dev/oawiki/blob/main/src/other/examplepage.md?plain=1> and <https://wiki.observational.space/other/examplepage.html>
 
-% Once you've made changes, you will commit them, with a commit message like "wrote base article" or "added section for jabberwalk tips" or "fixed inaccuracy about Vorpal Blades". Next GitHub will talk about forking the repository, which you'll want to do, and then you'll open a pull request with your changes. After that, a maintainer will greenlight it and merge it into the site. For more details, you can check https://github.com/observational-dev/oawiki/blob/main/README.md or ask in the discord - we are grateful for all your help writing the wiki and want to make it as easy as possible :)
+% Once you've made changes, you will commit them, with a commit message like "wrote base article" or "added section for jabberwalk tips" or "fixed inaccuracy about Vorpal Blades". Next GitHub will talk about forking the repository, which you'll want to do, and then you'll open a pull request with your changes. After that, a maintainer will greenlight it and merge it into the site. For more details, you can check <https://github.com/observational-dev/oawiki/blob/main/README.md> or ask in the discord - we are grateful for all your help writing the wiki and want to make it as easy as possible :)
diff --git a/src/beginning/newtonians.md b/src/beginning/newtonians.md
@@ -0,0 +1,9 @@
+# Newtonians
+
+It looks like this page hasn't been written yet. Would you be willing to [help](https://github.com/observational-dev/oawiki/blob/main/README.md)?
+
+% This line won't show up on the wiki, cuz it starts with a %. Anyway, it's here to give you some tips editing. You can delete these bits at your convenience.
+
+% The preview in GitHub will be close to how the page will look on the wiki, but not quite exact. For fomatting examples, see examplepage source and examplepage on the wiki - respectively <https://github.com/observational-dev/oawiki/blob/main/src/other/examplepage.md?plain=1> and <https://wiki.observational.space/other/examplepage.html>
+
+% Once you've made changes, you will commit them, with a commit message like "wrote base article of Vorpal Blades (yourname)" or "added section for jabberwalk tips (yourname)". Next GitHub will talk about forking the repository, which you'll want to do, and then you'll open a pull request with your changes. After that, a maintainer will greenlight it and merge it into the site. For more details, you can check <https://github.com/observational-dev/oawiki/blob/main/README.md> or ask in the discord - we are grateful for all your help writing the wiki and want to make it as easy as possible :)
diff --git a/src/imaging/planetary_imaging.md b/src/imaging/planetary_imaging.md
@@ -1,24 +1,29 @@
-<img align="right" src="https://t3.gstatic.com/licensed-image?q=tbn:ANd9GcQUNGwc8h9VqUTHCmp-42Ph6G4YbjA6N2sCxtCTjNgkCFuw0Ms5eZMzZDZI9y97Rh2I" alt="My Image" width=300>
-
 # Planetary Imaging
 
-Planetary imaging is the process of using a [telescope](https://) to produce an image of a planet, [the moon](https://), or other high magnification targets. The process is distinct from typical [astrophotography](https://) in that, instead of taking several long exposures, many short exposures are taken and the best among them are summarily [stacked](https://) to produce an image greater than the sum of its parts. A stacked planetary image results in a sharper result. This is typically referred to as "lucky imaging".
+```{image} https://t3.gstatic.com/licensed-image?q=tbn:ANd9GcQUNGwc8h9VqUTHCmp-42Ph6G4YbjA6N2sCxtCTjNgkCFuw0Ms5eZMzZDZI9y97Rh2I
+:align: right
+:width: 300
+```
+
+Planetary imaging is the process of using a [telescope](../beginning/telescope.md) to produce an image of a planet, the moon, or other high magnification targets. The process is distinct from typical [astrophotography](../imaging/index.md) in that, instead of taking several long exposures, many short exposures are taken and the best among them are summarily [stacked](../imaging/software.md) to produce an image greater than the sum of its parts. A stacked planetary image results in a sharper result. This is typically referred to as "lucky imaging".
 
 ## Capture Techniques
 
-There are several methods to produce a planetary image, ranging from cheap and easy to expensive and time consuming. Typically, the choice is made for the astrophotographer: The untracked drift method, or any kind of equatorial tracking.
+There are several methods to produce a planetary image, ranging from cheap and easy to expensive and time consuming. Typically, the choice is made for the astrophotographer: The untracked drift method, or any kind of [equatorial tracking](#equatorial-platforms).
 
 ### Drift
 
-The [drift method](https://) relies on planetary imaging software such as PIPP to find the planet in any given frame, crop the image, and stack it with the rest of the frames.
+The drift method relies on planetary imaging software such as PIPP to find the planet in any given frame, crop the image, and stack it with the rest of the frames.
+
+Because the software automatically centers and crops the image, no tracking is required. This is an excellent choice for users of [newtonians](../beginning/newtonians.md) and most [equatorial platforms](#equatorial-platforms).
 
-Because the software automatically centers and crops the image, no tracking is required. This is an excellent choice for users of [newtonians](https://) and most [equatorial platforms](https://).
+(equatorial-platforms)=
 
 ### Equatorial Tracking
 
-This method relies on a telescope mounted to either an equatorial platform or an equatorial mount. With accurate [equatorial tracking](https://), this can circumvent programs like [PIPP](https://) since the planet does not change its position relative to the camera's frame.
+This method relies on a telescope mounted to either an equatorial platform or an equatorial mount. With accurate equatorial tracking, this can circumvent programs like [PIPP](../imaging/software.md) since the planet does not change its position relative to the camera's frame.
 
-This ability to move straight from stacking to processing saves time, and is typically beneficial to the resultant image. It also allows higher relative [image scale](https://) since the position in the frame does not move.
+This ability to move straight from stacking to processing saves time, and is typically beneficial to the resultant image. It also allows higher relative [image scale](../imaging/understanding_ap.md) since the position in the frame does not move.
 
 ## Processing
 

diff --git a/src/telescopemaking/resources.md b/src/telescopemaking/resources.md
@@ -4,7 +4,7 @@ Below are some of the most commonly recommended resources for designing telescop
 
 ## General Newtonian Design
 
-[Newtonian Telescope Designer by Mel Bartels](https://)
+[Newtonian Telescope Designer by Mel Bartels](https://www.bbastrodesigns.com/NewtDesigner.html)
 
 - Comprehensive Newtonian telescope building tool
 - Interlinked calculators that produce accurate and quantitative measurements