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.

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

README: Improve description of the project #28

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

README: Improve description of the project #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Paraview-doc

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

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

* 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.


Note that the project hosting the user's guide, reference manual and tutorials published at https://docs.paraview.org is hosted at https://gitlab.kitware.com/paraview/paraview-docs.

## selector.js

Expand Down