Skip to content

Commit 9504770

Browse files
committed
Fix issues after reviewing PR
1 parent 159d150 commit 9504770

3 files changed

Lines changed: 10 additions & 17 deletions

File tree

.github/workflows/build-docs.yml

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ name: Build and deploy docs
33
on:
44
# Trigger the workflow on push
55
push:
6-
# Every branch
7-
branches:
8-
- '**'
6+
# To the develop and master branches
7+
branches: [develop, master]
8+
99
# Allows you to run this workflow manually from the Actions tab
1010
workflow_dispatch:
1111

@@ -71,7 +71,7 @@ jobs:
7171
# https://www.mkdocs.org
7272
- name: Install MkDocs and its dependencies
7373
run: >
74-
pip install mkdocs mkdocs-material 'mkdocs-autorefs<1.3.0'
74+
pip install mkdocs mkdocs-material 'mkdocs-autorefs<1.3.0'
7575
mkdocs-jupyter mkdocs-plugin-inline-svg
7676
mkdocs-markdownextradata-plugin mkdocstrings-python
7777
@@ -100,7 +100,7 @@ jobs:
100100
cp assets-branding/EasyDiffraction/icons/ed-icon_256x256.png docs/assets/images/favicon.png
101101
mkdir -p overrides/.icons/
102102
cp assets-branding/EasyDiffraction/icons/ed-icon_bw.svg overrides/.icons/easydiffraction.svg
103-
cp assets-branding/EasyScience/icons/es-icon_bw.svg overrides/.icons/easyscience.svg
103+
cp assets-branding/EasyScienceOrg/icons/eso-icon_bw.svg overrides/.icons/easyscience.svg
104104
105105
# Copy Jupyter notebooks from the project to the docs folder
106106
# The notebooks are used to generate the documentation
@@ -119,10 +119,7 @@ jobs:
119119
# - assets-docs/mkdocs.yml - the common configuration (theme, plugins, etc.)
120120
# - docs/mkdocs.yml - the project-specific configuration (project name, TOC, etc.)
121121
- name: Create mkdocs.yml file
122-
run: |
123-
cp assets-docs/mkdocs.yml mkdocs.yml
124-
echo "" >> mkdocs.yml
125-
cat docs/mkdocs.yml >> mkdocs.yml
122+
run: cat ../assets-docs/mkdocs.yml docs/mkdocs.yml > mkdocs.yml
126123

127124
# Build the static files
128125
# Input: docs/ directory containing the Markdown files

DEVELOPMENT.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,9 @@ This is an example of a workflow that describes the development process.
8686
cp ../assets-branding/EasyDiffraction/icons/ed-icon_256x256.png docs/assets/images/favicon.png
8787
mkdir -p overrides/.icons/
8888
cp ../assets-branding/EasyDiffraction/icons/ed-icon_bw.svg overrides/.icons/easydiffraction.svg
89-
cp ../assets-branding/EasyScience/icons/es-icon_bw.svg overrides/.icons/easyscience.svg
89+
cp ../assets-branding/EasyScienceOrg/icons/eso-icon_bw.svg overrides/.icons/easyscience.svg
9090
cp -R examples/ docs/examples/
91-
cp ../assets-docs/mkdocs.yml mkdocs.yml
92-
echo "" >> mkdocs.yml
93-
cat docs/mkdocs.yml >> mkdocs.yml
91+
cat ../assets-docs/mkdocs.yml docs/mkdocs.yml > mkdocs.yml
9492
```
9593
- Build documentation with MkDocs - static site generator
9694
```console

tools/prepare_docs.sh

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,10 @@ cp ../assets-branding/EasyDiffraction/logos/edl-logo_light.svg docs/assets/image
1212
cp ../assets-branding/EasyDiffraction/icons/ed-icon_256x256.png docs/assets/images/favicon.png
1313
mkdir -p overrides/.icons/
1414
cp ../assets-branding/EasyDiffraction/icons/ed-icon_bw.svg overrides/.icons/easydiffraction.svg
15-
cp ../assets-branding/EasyScience/icons/es-icon_bw.svg overrides/.icons/easyscience.svg
15+
cp ../assets-branding/EasyScienceOrg/icons/eso-icon_bw.svg overrides/.icons/easyscience.svg
1616

1717
echo "\033[0;33m:::::: Add Jupyter notebooks from the project to the docs/\033[0m"
1818
cp -R examples/ docs/examples/
1919

2020
echo "\033[0;33m:::::: Create the mkdocs.yml configuration file\033[0m"
21-
cp ../assets-docs/mkdocs.yml mkdocs.yml
22-
echo "" >> mkdocs.yml
23-
cat docs/mkdocs.yml >> mkdocs.yml
21+
cat ../assets-docs/mkdocs.yml docs/mkdocs.yml > mkdocs.yml

0 commit comments

Comments
 (0)