Skip to content

docs: remove texinfo #168

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

Closed
ycexiao wants to merge 5 commits into from
Closed

docs: remove texinfo #168

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
da24549
docs: remove doc/manual
ycexiao Mar 4, 2025
2f77f79
docs: remove reference to doc/manual
ycexiao Mar 4, 2025
1246aaf
docs: only include images in *Basic PDFmorph Workflow*
ycexiao Mar 4, 2025
aaa16a5
docs: add news
ycexiao Mar 4, 2025
92e87e0
docs: add pdfmorph.pdf and references to it.
ycexiao Mar 5, 2025
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
3 changes: 3 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,9 @@ You may consult our `online documentation <https://diffpy.github.io/diffpy.pdfmo
USING PDFmorph
------------------------------------------------------------------------

For detailed instructions and full tutorial, consult the user manual
on our `website <www.diffpy.org/diffpy.pdfmorph/>`.

Once the required software, including PDFmorph is all installed, open
up a terminal and check installation has worked properly by running ::

Expand Down
3 changes: 2 additions & 1 deletion doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ the plotted PDFs.
Finally, we note that though ``PDFmorph`` should work on other spectra
that are not PDFs, it has not been extensively tested beyond the PDF.

To get started, please visit the :ref:`quick_start`.
To get started, please download our :download:`user manual <pdfmorph.pdf>`
Copy link
Contributor

@sbillinge sbillinge Mar 5, 2025

Choose a reason for hiding this comment

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

I think the pdf version won't exist any more shortly, right? Just the version in the online docs. Isn't this the goal of your project?

Copy link
Collaborator Author

@ycexiao ycexiao Mar 5, 2025

Choose a reason for hiding this comment

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

Yes there will only be the online version. I think I misunderstood your previous comment, which said there should be a link to the manual. So I recovered the older version of pdf.

Now I am a little unsure, do we need the pdf manual built by rst? Because the information already exists and is better rendered in the online documents. Or just leave the link to the online documents.

Copy link
Contributor

@sbillinge sbillinge Mar 6, 2025

Choose a reason for hiding this comment

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

As guidance, maybe remember your goal and your target audience. It is a new user of PDFmorph. They have read the introduction and are excited to use it. What to do next? I think that person might like to given some possible "next steps" to get started. So if they see something like:
To get started, please visit the :ref:quick_start. I think it could be helpful, if when they click it and go there, there are nice and clear steps about how to get started. Did you test that "flow" as if you were a new user and see if you think it is easy to follow and makes sense? That is the task here that we are looking for.

Also, because we want to remove the PDF/texinfo manual, we want to double check that there is nothing in there that is NOT in the rst version of the manual that we might lose and don't want to lose. That can be on another PR.

Have you used PDFmorph? Do you know what it is for and how it works? This is probably important or you won't be able to do this job well.

Copy link
Collaborator Author

@ycexiao ycexiao Mar 6, 2025

Choose a reason for hiding this comment

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

Thanks for instructions. I see that the job here is more than just removing the files and replacing with the new ones. I will get into the repo itself and gain more insights about learning and using it through the old and new manuals.

or visit the :ref:`quick_start`.

=======
Authors
Expand Down
Binary file added doc/source/pdfmorph.pdf
View file
Open in desktop
Binary file not shown.
3 changes: 2 additions & 1 deletion doc/source/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ PDFmorph Tutorial
#################

Welcome! This will be a quick tutorial to accquaint users with PDFmorph
and some of what it can do.
and some of what it can do. For a more detailed tutorial, check out
our :download:`user manual <pdfmorph.pdf>`.
Copy link
Contributor

@sbillinge sbillinge Mar 5, 2025

Choose a reason for hiding this comment

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

please see above. no more texinfo so no more PDF version of the manual? Do we need to talk again to make sure our goals are aligned?


As we described in the README and installation instructions, please make
sure that you are familiar with working with your command line terminal
Expand Down
Loading