Skip to content

Commit

Permalink
added spell-check+link-check and fixed some links
Browse files Browse the repository at this point in the history
Signed-off-by: Nick Papior <[email protected]>
  • Loading branch information
zerothi committed Nov 4, 2023
1 parent 24c6406 commit f7a3485
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 4 deletions.
15 changes: 15 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,18 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

LINKCHECKDIR = build/linkcheck

.PHONY: spelling spell
spell: spelling
spelling:
$(SPHINXBUILD) -b spelling "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)


.PHONY: checklinks linkcheck
checklinks: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(LINKCHECKDIR)" $(SPHINXOPTS) $(O)
@echo
@echo "Check finished. Report is in $(LINKCHECKDIR)."
2 changes: 1 addition & 1 deletion docs/epilog.dummy
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
.. _scikit-build-core: https://scikit-build-core.readthedocs.io/en/latest/
.. _netcdf4-py: https://github.com/Unidata/netcdf4-python
.. _numpy: https://www.numpy.org/
.. _scipy: https://scipy.org/scipylib/index.html
.. _scipy: https://docs.scipy.org/doc/scipy
.. _pyparsing: https://github.com/pyparsing/pyparsing
.. _matplotlib: https://matplotlib.org/
.. _pytest: https://docs.pytest.org/en/stable/
Expand Down
4 changes: 1 addition & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,8 @@ the compilers used. Typically one may do
but sometimes ``setuptools`` does not intercept the flags in the build process.
Since 3.12 ``distutils`` has been deprecated and one needs to pass explicit linker flags to the CMake environment.
If problems arise, please help out the community by figuring out how this works on Windows.
If problems arise, please help out the community by figuring out how sisl can be compiled on Windows.

Adapt to compilers. For an explanation, see `here <https://docs.python.org/3/install/index.html#location-and-names-of-config-files>`_
or the `user issue <https://github.com/zerothi/sisl/issues/244>`_ which spurred this content.

.. _installation-testing:

Expand Down

0 comments on commit f7a3485

Please sign in to comment.