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.

Sign up for GitHub

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

Jump to bottom

change local documentation link to diffpy.org #203

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

change local documentation link to diffpy.org #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions src/diffpy/pdfgui/gui/mainframe.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2523,10 +2523,7 @@ def onDocumentation(self, event):
"""Show information about the documentation."""
import webbrowser

from six.moves.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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
APPDATADIR = os.path.abspath(APPDATADIR)

# Location of the HTML manual
docMainFile = os.path.join(APPDATADIR, "doc/manual/pdfgui.html")
docMainFile = "https://www.diffpy.org/diffpy.pdfgui/manual.html"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please check, this doesn't look right to me. If it is user-facing I think it ishould be to a published docs url (somewhere on github.io), but if it is used by the code to find a path to do something, it should be somewhere in a local doc/build folder, something like that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Refer to the discussion here: Billingegroup/cookiecutter#108, we probably not going to include doc in distribution. So the online url would be the way to go.

Yes I'll change all diffpy.org links to GitHub.io. One thing to make sure is how GitHub.io name its sub-pages and how it's mapping things to the current release in diffpy.org... Might need to do a solely doc "pre-release" sometime to make sure I'm not doing it wrong...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should be able to do a local build. If we want to test a deploy just add push: main to the doc y'all. We can remove it again after the test.


del _upbasedir
del _development_mode
Expand Down