Skip to content

Commit

Permalink
add extra notes to conventions.md change workflow file
Browse files Browse the repository at this point in the history
  • Loading branch information
Sajtospoga01 committed Dec 18, 2023
1 parent 75728a5 commit 788dddc
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/source/conventions_and_guidelines/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,16 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[dev]
pip install -U sphinx
pip install furo
pip install toml
pip install sphinx-mdinclude
- name: Build documentation
run: |
cd docs
sphinx-apidoc -e -M --force -o . ../utilities/
make html
sphinx-apidoc -e -M --force -o . ../src/
sphinx-build -b html ./source/ ./build/
- name: Upload build data
uses: actions/upload-artifact@v3
with:
Expand Down Expand Up @@ -91,7 +92,9 @@ jobs:

The action above can be updated to use other triggers, or to build from a project file.

>**Note:** The action above is a template, available as a tempalte repository (which is strongly encouraged to be used), however it should be updated to fit the project it is used for.
>**Note:** The action above is a template, available as a tempalte repository (which is strongly encouraged to be used, can be found [here](https://github.com/guorbit/software-template)), however it should be updated to fit the project it is used for.
>**Note:** Modules and packages used in the codebase has to be located inside the `src` folder, otherwise the documentation generator will not be able to find them.
### Typing

Expand Down

0 comments on commit 788dddc

Please sign in to comment.