change local documentation link to diffpy.org #203
Conversation
| @@ -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" | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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...
There was a problem hiding this comment.
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.
| @@ -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" | |||
There was a problem hiding this comment.
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.
|
@Tieqiong Hi Tieqiong, what's the status on this PR? Trying to close as much as we can |
|
@Tieqiong seems to be closing one of the issues in the 3.1.0 milestone. Could you please share an update? |
closes #172