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

Documentation in the help tab #172

Open
Tieqiong opened this issue Aug 20, 2024 · 2 comments · May be fixed by #203
Open

Documentation in the help tab #172

Tieqiong opened this issue Aug 20, 2024 · 2 comments · May be fixed by #203
Milestone

Comments

@Tieqiong
Copy link
Contributor

Tieqiong commented Aug 20, 2024

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
Copy link
Contributor

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?

@sbillinge sbillinge added this to the v3.1.0 milestone Aug 20, 2024
@Tieqiong
Copy link
Contributor Author

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.

@Tieqiong Tieqiong linked a pull request Aug 26, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants