search

diffpy / diffpy.pdfgui

graphical user interface for real space structure refinement to PDF
Other
20 stars 29 forks source link

Documentation in the help tab #172

Open Tieqiong opened 2 months ago

Tieqiong commented 2 months ago

When using pdfgui, there's the help tab we people are supposed to be able to see the user manual. However the way the package does this is to open the absolute path of the html file where the package is installed to in the browser. This path is in the doc directory, while when we build the package we only include src directory (I'm not sure for the actual release but this is the case when I install it locally). Thus users can't open the manual because it's not included when they install the package.

@sbillinge We can either include the doc directory in the setuptool build or change the approach by giving the link to the online user manual which is hopefully going to be deployed according to the new convention.

sbillinge commented 2 months ago

How is it done in our "cookiecutter" templates, diffpy.utils and diffpy.pdfmorph. Let's use that approach if it works.

It seems as if example/tutorial data may have to come with the package though? Or do we want to link to it on GH?

Tieqiong commented 2 months ago

No matter how we want to do this (keep the doc dir during release or link it to the online page) we want to check and change the wording on the main documentation page and readme.

bobleesj commented 1 month ago

@Tieqiong will fix this for 3.1.0