Skip to content

Commit

Permalink
pre-commit run -a
Browse files Browse the repository at this point in the history
  • Loading branch information
alanlujan91 committed Feb 6, 2024
1 parent b0e9288 commit 766db0f
Show file tree
Hide file tree
Showing 36 changed files with 1,774 additions and 625 deletions.
16 changes: 6 additions & 10 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,24 @@ labels: ""
assignees: ""
---

**Describe the bug**
A clear and concise description of what the bug is.
**Describe the bug** A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
**To Reproduce** Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.
**Expected behavior** A clear and concise description of what you expected to
happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.
**Screenshots** If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**

- OS: [e.g. Mac/Windows/Linux]
- Browser [e.g. chrome, safari]
- Econ-ARK and Python version [eg. 0.10.6 and python 3.7]

**Additional context**
Add any other context about the problem here.
**Additional context** Add any other context about the problem here.
3 changes: 2 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Please ensure your pull request adheres to the following guidelines:

<!--- Put an `x` in all the boxes that apply: -->

- [ ] Tests for new functionality/models or Tests to reproduce the bug-fix in code.
- [ ] Tests for new functionality/models or Tests to reproduce the bug-fix in
code.
- [ ] Updated documentation of features that add new functionality.
- [ ] Update CHANGELOG.md with major/minor changes.
26 changes: 10 additions & 16 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,7 @@ jobs:

- name: Run Sphinx
run: >
sphinx-build
-M html Documentation HARK-docs
-T
-W
-j auto
sphinx-build -M html Documentation HARK-docs -T -W -j auto
- name: Set up git for deployment
run: |
Expand All @@ -68,12 +64,13 @@ jobs:
- name: Deploy to GitHub Pages
# Only deploy to Pages on pushes to HEAD
if: (github.repository_owner == 'Econ-ARK') && (github.event_name == 'push') && (github.ref_name == 'master')
if:
(github.repository_owner == 'Econ-ARK') && (github.event_name ==
'push') && (github.ref_name == 'master')
run: >
git push
--force
https://x-access-token:${{ github.token }}@github.com/${{ github.repository }}
`git subtree split --prefix HARK-docs/html gh-pages`:refs/heads/gh-pages
git push --force https://x-access-token:${{ github.token
}}@github.com/${{ github.repository }} `git subtree split --prefix
HARK-docs/html gh-pages`:refs/heads/gh-pages
lint:
runs-on: ubuntu-latest
Expand All @@ -90,9 +87,6 @@ jobs:
python -m pip install --upgrade sphinx-lint
- name: Lint documentation with sphinx-lint
run: >
sphinx-lint
--ignore Documentation/example_notebooks/GenIncProcessModel.py
--enable all
--max-line-length 85
README.md
Documentation/
sphinx-lint --ignore
Documentation/example_notebooks/GenIncProcessModel.py --enable all
--max-line-length 85 README.md Documentation/
7 changes: 4 additions & 3 deletions .github/workflows/execute-notebooks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ jobs:
title: "[bot] Execute example notebooks"
# language=Markdown
body: >
This PR was [automatically generated] to re-execute
the example notebooks for use in the documentation.
This PR was [automatically generated] to re-execute the example
notebooks for use in the documentation.
[automatically generated]: https://github.com/Econ-ARK/HARK/actions/workflows/execute-notebooks.yml
[automatically generated]:
https://github.com/Econ-ARK/HARK/actions/workflows/execute-notebooks.yml
737 changes: 527 additions & 210 deletions docs/CHANGELOG.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/NARK/Resources/texmf-local/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# texmf-local contains customizations of LaTeX

If you use TeXLive on more than one system, or under more than one username,
it is useful to have a set of customizations that are shared across all your
If you use TeXLive on more than one system, or under more than one username, it
is useful to have a set of customizations that are shared across all your
identities and machines.

This can be accomplished in a number of ways.
Expand Down

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/NARK/Resources/texmf-local/tex/latex/printvrb.sty
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,4 @@ no fragment {\tt ==> #1 <==} maybe run LaTeX on source file again?)\vskip12pt\el
\ifnamesinmargin
\vskip1sp\noindent\llap{\vtop to 0pt{\hbox{\tt #1\hskip4pt==>\ }\vss}}\fi%
\csname #1\endcsname\fi
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ The current version works

There seem to be two options:

1. If you never set a specified size of a figure (like \includegraphics[width=6in]) then the method discussed [here](https://tug.org/pipermail/tex4ht/2015q2/001166.html) works. But dies with a division by zero error whenever the size has been explicitly set. It can be resurrected by uncommenting the \Configure{graphics\*}{svg} portion of the file
1. In cases where the size is set (as is frequently the case), the current version obtains the dimensions directly from the svg file
1. If you never set a specified size of a figure (like
\includegraphics[width=6in]) then the method discussed
[here](https://tug.org/pipermail/tex4ht/2015q2/001166.html) works. But dies
with a division by zero error whenever the size has been explicitly set. It
can be resurrected by uncommenting the \Configure{graphics\*}{svg} portion of
the file
1. In cases where the size is set (as is frequently the case), the current
version obtains the dimensions directly from the svg file
- This might have problems with an svg file without explicit dimensions
4 changes: 2 additions & 2 deletions docs/NARK/Resources/texmf-local/texmf-local/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# texmf-local contains customizations of LaTeX

If you use TeXLive on more than one system, or under more than one username,
it is useful to have a set of customizations that are shared across all your
If you use TeXLive on more than one system, or under more than one username, it
is useful to have a set of customizations that are shared across all your
identities and machines.

This can be accomplished in a number of ways.
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,4 @@ no fragment {\tt ==> #1 <==} maybe run LaTeX on source file again?)\vskip12pt\el
\ifnamesinmargin
\vskip1sp\noindent\llap{\vtop to 0pt{\hbox{\tt #1\hskip4pt==>\ }\vss}}\fi%
\csname #1\endcsname\fi
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ The current version works

There seem to be two options:

1. If you never set a specified size of a figure (like \includegraphics[width=6in]) then the method discussed [here](https://tug.org/pipermail/tex4ht/2015q2/001166.html) works. But dies with a division by zero error whenever the size has been explicitly set. It can be resurrected by uncommenting the \Configure{graphics\*}{svg} portion of the file
1. In cases where the size is set (as is frequently the case), the current version obtains the dimensions directly from the svg file
1. If you never set a specified size of a figure (like
\includegraphics[width=6in]) then the method discussed
[here](https://tug.org/pipermail/tex4ht/2015q2/001166.html) works. But dies
with a division by zero error whenever the size has been explicitly set. It
can be resurrected by uncommenting the \Configure{graphics\*}{svg} portion of
the file
1. In cases where the size is set (as is frequently the case), the current
version obtains the dimensions directly from the svg file
- This might have problems with an svg file without explicit dimensions
2 changes: 1 addition & 1 deletion docs/example_notebooks/ConsPortfolioModel.ipynb
2 changes: 1 addition & 1 deletion docs/example_notebooks/GenIncProcessModel.ipynb
2 changes: 1 addition & 1 deletion docs/example_notebooks/GenIncProcessModel.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
../../examples/GenIncProcessModel/GenIncProcessModel.py
../../examples/GenIncProcessModel/GenIncProcessModel.py
2 changes: 1 addition & 1 deletion docs/example_notebooks/Gentle-Intro-To-HARK.ipynb
2 changes: 1 addition & 1 deletion docs/example_notebooks/IndShockConsumerType.ipynb
2 changes: 1 addition & 1 deletion docs/example_notebooks/Journey-PhD.ipynb
2 changes: 1 addition & 1 deletion docs/example_notebooks/JourneyPhDparam.py
2 changes: 1 addition & 1 deletion docs/example_notebooks/KinkedRconsumerType.ipynb
2 changes: 1 addition & 1 deletion docs/example_notebooks/LifecycleModel.ipynb
2 changes: 1 addition & 1 deletion docs/example_notebooks/PerfForesightConsumerType.ipynb
Loading

0 comments on commit 766db0f

Please sign in to comment.