Skip to content

Commit

Permalink
Google Summer of Code’22: Port fortran-lang.org to Sphinx (#35)
Browse files Browse the repository at this point in the history
- added pr preview banner for preview builds. (independent of the pydata theme version)
- added documentation for pre-commit hooks
- locked the dependency versions of packages
- formatted the html templates
- resolved the date error in newsletter of june 2022
- enabled build of all translations for build preview
- resolved button text translated removes all the button properties #29 (for index page)
- added dependabot for requirements.txt
- updated translations
  • Loading branch information
henilp105 committed Aug 12, 2022
1 parent e701a09 commit 14c675e
Show file tree
Hide file tree
Showing 20 changed files with 2,754 additions and 2,685 deletions.
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,9 @@ updates:
directory: "/" # search in .github/workflows
schedule:
interval: "weekly" # check for action updates every week

- package-ecosystem: "pip" # search for requirements.txt
directory: "/"
schedule:
interval: "weekly" # check for action updates every week

4 changes: 2 additions & 2 deletions .github/workflows/preview_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Build page
run: make dirhtml LANGUAGES=en
run: make dirhtml

- run: touch build/html/.nojekyll

Expand All @@ -59,5 +59,5 @@ jobs:
uses: peter-evans/create-or-update-comment@v2
with:
issue-number: ${{github.event.issue.number}}
body: "This PR is being built with Sphinx and can be previewed at: /pr/${{github.event.issue.number}}"
body: "This PR has been built with Sphinx and can be previewed at: /pr/${{github.event.issue.number}}"

2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ $(BUILDDIR)/html/CNAME: source/html/CNAME

gettext: $(MAKEFILES)
@$(SPHINXBUILD) -b $@ "$(SOURCEDIR)" "$(BUILDDIR)/$@" $(SPHINXOPTS)
@$(SPHINXINTL) update -p "$(BUILDDIR)/$@" -d locale $(addprefix -l,$(filter-out en,$(LANGUAGES)))
@$(SPHINXINTL) update -p "$(BUILDDIR)/$@" -d locale $(addprefix -l,$(filter-out en,$(LANGUAGES)))
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,39 @@ To limit the build to a single language subtree, *i.e.* English, use
```
make dirhtml LANGUAGES=en
```
### Activating the pre-commit hooks for Black and Pylint:

This assumes that you already have a cloned the main branch of this repository.
Steps to activate the pre-commit hooks are:
1. Make sure that you have installed all the dependencies of the repository.
```
pip3 install --user -r requirements.txt
```
2. Activate the pre-commit hooks:
```
pre-commit install
```
Now, the precommit hooks have been successfully been installed into your clone.

#### Steps to debug/resolve issues which prevent the commit due to pre-commit hooks:

1. if pylint causes the issues in commiting to the repo, and it seems mandatory to `skip`
the pre-commit hooks use:

```
SKIP=pylint git commit -m"my commit"`
```
2. if black causes the issues in commiting to the repo, and it seems mandatory to `skip`
the pre-commit hooks use:

```
SKIP=black git commit -m"my commit"
```
### Translating via weblate

Translations can be contributed via [weblate](https://hosted.weblate.org/projects/fortran-lang/fpm/).
Translations can be contributed via [weblate](https://hosted.weblate.org/projects/fortran-lang/webpage/).

[![Translation status](https://hosted.weblate.org/widgets/fortran-lang/-/fpm/horizontal-auto.svg)](https://hosted.weblate.org/engage/fortran-lang/)
[![Translation status](https://hosted.weblate.org/widgets/fortran-lang/-/webpage/horizontal-auto.svg)](https://hosted.weblate.org/engage/fortran-lang/)


### Update or add translations
Expand Down
6 changes: 3 additions & 3 deletions locale/de/LC_MESSAGES/index.po
Original file line number Diff line number Diff line change
Expand Up @@ -1812,9 +1812,9 @@ msgstr "Die Fortran-Programmiersprache"
msgid "High-performance parallel programming language"
msgstr "Hochperformanz, parallele Programmiersprache"

#: ../../source/index.md:11
msgid "Get started"
msgstr "Erste Schritte"
#: ../../source/index.md:12
msgid "{bdg-link-primary}`Get started <learn/>`"
msgstr "{bdg-link-primary}`Erste Schritte <learn/>`"

#: ../../source/index.md:18
msgid "Features"
Expand Down
Loading

0 comments on commit 14c675e

Please sign in to comment.