Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doc workflow #3

Merged
merged 14 commits into from
Oct 29, 2023
Prev Previous commit
Next Next commit
Fix links documentation
ericpre committed Oct 29, 2023
commit 35f022ba1d81a5158ee32277a0ca21369bc42914
2 changes: 1 addition & 1 deletion doc/citing.rst
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ Citing exSpy

If exSpy has been significant to a project that leads to an academic
publication, please acknowledge that fact by citing it. The DOI in the
badge below is the `Concept DOI <https://help.zenodo.org/fag/#versioning>`_ --
badge below is the `Concept DOI <https://help.zenodo.org/faq/#versioning>`_ --
it can be used to cite the project without referring to a specific
version. If you are citing HoloSpy because you have used it to process data,
please use the DOI of the specific version that you have employed. You can
5 changes: 5 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -42,6 +42,11 @@
"sphinx.ext.napoleon",
]

linkcheck_ignore = [
"https://doi.org/10.1021/acs.nanolett.5b00449", # 403 Client Error: Forbidden for url
"https://onlinelibrary.wiley.com/doi/10.1111/j.1365-2818.2006.01549.x", # 403 Client Error: Forbidden for url
]

intersphinx_mapping = {
"dask": ("https://docs.dask.org/en/latest", None),
"hyperspy": ("https://hyperspy.org/hyperspy-doc/dev", None),
4 changes: 2 additions & 2 deletions doc/intro.rst
Original file line number Diff line number Diff line change
@@ -73,11 +73,11 @@ Learning resources
There are many ways you can help!

Citing exSpy
=================
============

If exSpy has been significant to a project that leads to an academic
publication, please acknowledge that fact by citing it. The DOI in the
badge below is the `Concept DOI <https://help.zenodo.org/#versioning>`_ of
badge below is the `Concept DOI <https://help.zenodo.org/faq/#versioning>`_ of
HyperSpy. It can be used to cite the project without referring to a specific
version. If you are citing exSpy because you have used it to process data,
please use the DOI of the specific version that you have employed. You can