Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@cibinjoseph
cibinjoseph committed Feb 23, 2021
2 parents e707bbd + c477d06 commit e414831
Show file tree
Hide file tree
Showing 71 changed files with 533 additions and 495 deletions.
13 changes: 7 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@ naturalFRUIT has been tested to work with gfortran and ifort for all versions of
All contributions are to be made to the `dev` branch through pull requests. The `master` branch is kept aside for releases.

### Creating documentation
For adding new documentation,
1. Fork this repo.
2. FORD parses comments with the marks *!!* in the source code and the folder *ford_input/* for creating documentation. Make the necessary changes.
4. Run the bash script `createDocs.sh` in the topmost directory of the repo to make FORD autocreate the documentation webpages.
5. Commit all changes.
6. Send a pull request.
For adding new documentation,
1. Fork this repo.
2. FORD parses comments with the marks *!!* in the source code and contents of the folder *ford_input/* for creating documentation.
3. Make the necessary changes.
4. Run the bash script `createDocs.sh` in the topmost directory of the repo to make FORD autocreate the documentation webpages.
5. Commit all changes.
6. Send a pull request.

## License
[BSD-3-Clause](LICENSE)
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ <h3>Procedures</h3>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
2 changes: 1 addition & 1 deletion docs/interface/add_fail.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ <h4>Arguments</h4>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
2 changes: 1 addition & 1 deletion docs/interface/assert_equal.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2546,7 +2546,7 @@ <h4>Arguments</h4>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
2 changes: 1 addition & 1 deletion docs/interface/assert_not_equal.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2546,7 +2546,7 @@ <h4>Arguments</h4>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
2 changes: 1 addition & 1 deletion docs/lists/files.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h1>Source Files</h1>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
2 changes: 1 addition & 1 deletion docs/lists/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h1>Modules</h1>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
2 changes: 1 addition & 1 deletion docs/lists/procedures.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ <h1>Procedures</h1>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
8 changes: 4 additions & 4 deletions docs/media/naturalFRUIT-logo-short.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/module/fruit_mpi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ <h3>Contents</h3>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
2 changes: 1 addition & 1 deletion docs/module/naturalfruit.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7840,7 +7840,7 @@ <h4>Arguments</h4>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
6 changes: 3 additions & 3 deletions docs/page/AssertMethods/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,12 +199,12 @@ <h4>3. <code><a href="../../proc/assert_identical.html">assert_identical</a></co
<ul class="nav nav-stacked nav-pills">

<li role="presentation">
<a href='../../page/Tutorials/tutorial0/index.html'>Tutorial 0</a>
<a href='../../page/Tutorials/tutorial1/index.html'>Tutorial 1</a>

</li>

<li role="presentation">
<a href='../../page/Tutorials/tutorial1/index.html'>Tutorial 1</a>
<a href='../../page/Tutorials/tutorial2/index.html'>Tutorial 2</a>

</li>

Expand All @@ -223,7 +223,7 @@ <h4>3. <code><a href="../../proc/assert_identical.html">assert_identical</a></co
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
6 changes: 3 additions & 3 deletions docs/page/DeprecatedMethods/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,12 +185,12 @@ <h1>Deprecated methods</h1>
<ul class="nav nav-stacked nav-pills">

<li role="presentation">
<a href='../../page/Tutorials/tutorial0/index.html'>Tutorial 0</a>
<a href='../../page/Tutorials/tutorial1/index.html'>Tutorial 1</a>

</li>

<li role="presentation">
<a href='../../page/Tutorials/tutorial1/index.html'>Tutorial 1</a>
<a href='../../page/Tutorials/tutorial2/index.html'>Tutorial 2</a>

</li>

Expand All @@ -209,7 +209,7 @@ <h1>Deprecated methods</h1>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
6 changes: 3 additions & 3 deletions docs/page/MajorChanges/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,12 +169,12 @@ <h1>Major changes</h1>
<ul class="nav nav-stacked nav-pills">

<li role="presentation">
<a href='../../page/Tutorials/tutorial0/index.html'>Tutorial 0</a>
<a href='../../page/Tutorials/tutorial1/index.html'>Tutorial 1</a>

</li>

<li role="presentation">
<a href='../../page/Tutorials/tutorial1/index.html'>Tutorial 1</a>
<a href='../../page/Tutorials/tutorial2/index.html'>Tutorial 2</a>

</li>

Expand All @@ -193,7 +193,7 @@ <h1>Major changes</h1>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
10 changes: 5 additions & 5 deletions docs/page/Tutorials/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,10 @@ <h1>Tutorials</h1>
<li><i class="fa fa-sitemap"></i> Subsections:</li>
<li><a href='../../page/Tutorials/tutorial0/index.html'>Tutorial 0</a></li>
<li><a href='../../page/Tutorials/tutorial1/index.html'>Tutorial 1</a></li>
<li><a href='../../page/Tutorials/tutorial2/index.html'>Tutorial 2</a></li>
-->
</ul>
Expand Down Expand Up @@ -207,12 +207,12 @@ <h3>Contents:</h3>
<ul class="nav nav-stacked nav-pills">

<li role="presentation">
<a href='../../page/Tutorials/tutorial0/index.html'>Tutorial 0</a>
<a href='../../page/Tutorials/tutorial1/index.html'>Tutorial 1</a>

</li>

<li role="presentation">
<a href='../../page/Tutorials/tutorial1/index.html'>Tutorial 1</a>
<a href='../../page/Tutorials/tutorial2/index.html'>Tutorial 2</a>

</li>

Expand All @@ -231,7 +231,7 @@ <h3>Contents:</h3>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-6 col-md-4"><p>&copy; 2020
<div class="col-xs-6 col-md-4"><p>&copy; 2021
</p></div>
<div class="col-xs-6 col-md-4 col-md-push-4">
<p class="text-right">
Expand Down
Loading

0 comments on commit e414831

Please sign in to comment.