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 improvements #142

Merged
merged 47 commits into from
Feb 19, 2024
Merged

Documentation improvements #142

merged 47 commits into from
Feb 19, 2024

Conversation

RKrahl
Copy link
Member

@RKrahl RKrahl commented Nov 22, 2023

Improve the following things to improve in the documentation:

  • install instruction: explain how to verify the signature in order check the integrity of the source distribution. Point out that the installation using pip does not support this check. As a consequence, point to the distribution page at Github as the recommended download source, because it also offers the signature file (as opposed to PyPI).
  • better describe the the input file format for module icat.ingest as defined by the provided XSD files.
  • add more reference labels in order to get permalinks that could be stable across versions, in particular in the changelog, but maybe also at other places.
  • Fix ReST style of documentation sources: tabulation used for indentation, trailing white space, excessively long lines. Add GitHub action to check ReST style.

See the online documentation on Read the Docs for this branch.

Close #141

@RKrahl RKrahl added the documentation Improvements or additions to documentation label Nov 22, 2023
@RKrahl RKrahl added this to the 1.3.0 milestone Dec 11, 2023
@RKrahl RKrahl force-pushed the doc branch 2 times, most recently from 876211f to 8aa3405 Compare December 21, 2023 10:51
e.g. essentially update tha Sphinx version used for building the
documentation
RKrahl added 10 commits January 16, 2024 12:36
  inline examples
- Drop icatdump-simple-2.xml example, rename icatdump-simple-1.xml to
  icatdump-simple.xml
- Drop icatdump-simple-2.yaml example, rename icatdump-simple-1.yaml
  to icatdump-simple.yaml
a Subsection References to ICAT objects and unique keys
much better explained in the online documentation
icat.dumpfile.DumpFileReader and class icat.dumpfile.DumpFileWriter
are abstract and thus need to implemented in the file format specific
backend
repository in order to get the correct version number in the
diagnostics
- Point out that a manual install does not automatically install
  dependencies,
- Removed yet another reference of PyPI yo get release versions from,
- Minor formulation fix.
@RKrahl RKrahl marked this pull request as ready for review February 19, 2024 17:15
@RKrahl RKrahl merged commit 6f6111f into develop Feb 19, 2024
1 check passed
@RKrahl RKrahl deleted the doc branch February 19, 2024 17:18
@RKrahl RKrahl mentioned this pull request Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation improvements
1 participant