Skip to content

Commit

Permalink
doc: update details on build of doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mrava87 committed Nov 29, 2023
1 parent f046b4a commit fe2ade6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 33 deletions.
17 changes: 2 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,6 @@ simply typing
make docupdate
```

Since the tutorials are too heavy to be created by documentation web-services like Readthedocs, our documentation
is hosted on Github-Pages and run locally on a separate branch. To get started create the following branch both locally
and in your remote fork:
```
git checkout -b gh-pages
git push -u origin gh-pages
```

Every time you want to update and deploy the documentation run:
```
make docpush
```
This will automatically move to the `gh-pages` branch, build the documentation and push it in the equivalent remote branch.
You can finally make a Pull Request for your local `gh-pages` branch to the `gh-pages` in the DIG-Kaust repository,

Our documentation is hosted on Github-Pages and created with a Github-Action triggered every time a commit is made
to the main branch.

20 changes: 2 additions & 18 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,21 +108,5 @@ simply typing
>> make docupdate
Since the tutorials are too heavy to be created by documentation web-services like Readthedocs, our documentation
is hosted on Github-Pages and run locally on a separate branch. To get started create the following branch both locally
and in your remote fork:

.. code-block:: bash
>> git checkout -b gh-pages
>> git push -u origin gh-pages
Every time you want to update and deploy the documentation run:

.. code-block:: bash
>> make docpush
This will automatically move to the `gh-pages` branch, build the documentation and push it in the equivalent remote branch.
You can finally make a Pull Request for your local `gh-pages` branch to the `gh-pages` in the DIG-Kaust repository,

Our documentation is hosted on Github-Pages and created with a Github-Action triggered every time a commit is made
to the main branch.

0 comments on commit fe2ade6

Please sign in to comment.