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

README: Improve description of the project #28

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jcfr
Copy link
Member

@jcfr jcfr commented Apr 18, 2023

Automated publication of ParaView documentation via github pages.
Automated publication of ParaView documentation via GitHub pages.

Given Paraview source and build trees, tt provides the infrastructure for
Copy link
Collaborator

Choose a reason for hiding this comment

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

typo tt

* generating the associated ParaView C++ and Python API documentation
* automatically updating the site available at https://kitware.github.io/paraview-docs/ after changes are pushed onto the `gh-pages` branch

The updates to the `gh-pages` branch are pushed every night by the official "dashboard" build & testing ParaView and maintained by [@Kitware](https://github.com/Kitware).
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
The updates to the `gh-pages` branch are pushed every night by the official "dashboard" build & testing ParaView and maintained by [@Kitware](https://github.com/Kitware).
The updates to the `gh-pages` branch are pushed every night by the official "dashboard" building & testing ParaView and maintained by [@Kitware](https://github.com/Kitware).

Copy link
Collaborator

Choose a reason for hiding this comment

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

This sentence is odd, maybe:

The updates to the gh-pages branch are pushed every night by the official ParaView CI infrastructure which is maintained by @Kitware.

Automated publication of ParaView documentation via github pages.
Automated publication of ParaView documentation via GitHub pages.

Given Paraview source and build trees, tt provides the infrastructure for
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
Given Paraview source and build trees, tt provides the infrastructure for
Given Paraview source and build trees, it provides the infrastructure for

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 this pull request may close these issues.

2 participants