Skip to content

Commit

Permalink
docs: correct manual link (#249)
Browse files Browse the repository at this point in the history
* docs: correct manual link

* [pre-commit.ci] auto fixes from pre-commit hooks

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
Tieqiong and pre-commit-ci[bot] authored Jan 14, 2025
1 parent c7ac084 commit 1cb1890
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 4 deletions.
23 changes: 23 additions & 0 deletions news/doctab.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* <news item>

**Changed:**

* Changed the removed local manual link to the online page.

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
4 changes: 1 addition & 3 deletions src/diffpy/pdfgui/gui/mainframe.py
Original file line number Diff line number Diff line change
Expand Up @@ -2528,10 +2528,8 @@ def onSaveCalc(self, event):
def onDocumentation(self, event):
"""Show information about the documentation."""
import webbrowser
from urllib.request import pathname2url

url = "file://" + pathname2url(docMainFile)
webbrowser.open(url)
webbrowser.open(docMainFile)
return

# MISC INTERACTION ITEMS
Expand Down
2 changes: 1 addition & 1 deletion src/diffpy/pdfgui/gui/pdfguiglobals.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
APPDATADIR = os.path.abspath(APPDATADIR)

# Location of the HTML manual
docMainFile = os.path.join(APPDATADIR, "doc/manual/pdfgui.html")
docMainFile = "https://diffpy.github.io/diffpy.pdfgui/manual.html"

del _upbasedir
del _development_mode
Expand Down

0 comments on commit 1cb1890

Please sign in to comment.