Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolve all outstanding warnings on rendering documentation #1301

Merged
merged 19 commits into from
Jul 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ jobs:
sphinx-build
-M html Documentation HARK-docs
-T
-W

- name: Set up git for deployment
run: |
Expand Down
28 changes: 14 additions & 14 deletions Documentation/ARKitecture.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Documentation/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Release Date: February, 16, 2023
- Add methods to non stochastically simulate an economy by computing transition matrices. Functions to compute transition matrices and ergodic distribution have been added [#1155](https://github.com/econ-ark/HARK/pull/1155).
- Fixes a bug that causes `t_age` and `t_cycle` to get out of sync when reading pre-computed mortality. [#1181](https://github.com/econ-ark/HARK/pull/1181)
- Adds Methods to calculate Heterogenous Agent Jacobian matrices. [#1185](https://github.com/econ-ark/HARK/pull/1185)
- Enhances `combine_indep_dstns` to work with labeled distributions (`DiscreteDistributionLabeled`). [#1191](htttps://github.com/econ-ark/HARK/pull/1191)
- Enhances `combine_indep_dstns` to work with labeled distributions (`DiscreteDistributionLabeled`). [#1191](https://github.com/econ-ark/HARK/pull/1191)
- Updates the `numpy` random generator from `RandomState` to `Generator`. [#1193](https://github.com/econ-ark/HARK/pull/1193)
- Turns the income and income+return distributions into `DiscreteDistributionLabeled` objects. [#1189](https://github.com/econ-ark/HARK/pull/1189)
- Creates `UtilityFuncCRRA` which is an object oriented utility function with a coefficient of constant relative risk aversion and includes derivatives and inverses. Also creates `UtilityFuncCobbDouglas`, `UtilityFuncCobbDouglasCRRA`, and `UtilityFuncConstElastSubs`. [#1168](https://github.com/econ-ark/HARK/pull/1168)
Expand Down
20 changes: 19 additions & 1 deletion Documentation/conf.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
import warnings

try:
import numba
except ImportError:
pass
else:
warnings.filterwarnings("ignore",
message="numba.generated_jit.*",
category=numba.NumbaDeprecationWarning)
warnings.filterwarnings("ignore",
message=".* 'nopython' .*",
category=numba.NumbaDeprecationWarning)

# Project information
project = "HARK"
copyright = "2020, Econ-ARK team"
Expand All @@ -17,13 +31,14 @@
"sphinx.ext.napoleon",
"sphinx.ext.todo",
"nbsphinx",
"recommonmark",
"myst_parser",
]

exclude_patterns = [
"_build",
"Thumbs.db",
".DS_Store",
"NARK",
]

language = "en"
Expand Down Expand Up @@ -57,5 +72,8 @@
# sphinx.ext.autosummary configuration
autosummary_generate = True

# sphinx.ext.napoleon configuration
napoleon_use_ivar = True # solves duplicate object description warning

# nbsphinx configuration
nbsphinx_execute = "never" # This is currently not working
2 changes: 1 addition & 1 deletion Documentation/contributing/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [Contributing Guide](#contributing-guide)
- [Developer's Certificate of Origin 1.1](#developer-s-certificate-of-origin-1-1)

## [Code of Conduct](./doc/guides/contributing/coc.md)
## Code of Conduct

The Econ-ARK project has a
[Code of Conduct](https://github.com/econ-ark/HARK/blob/master/.github/CODE_OF_CONDUCT.md)
Expand Down
2 changes: 1 addition & 1 deletion Documentation/contributing/Installation_instruction.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ If you want to make changes or contributions (yay!) to HARK, you'll need to have

1. Navigate to wherever you want to put the repository and type `git clone [email protected]:econ-ark/HARK.git` ([more details here](https://git-scm.com/documentation)). If you get a permission denied error, you may need to setup SSH for GitHub, or you can clone using HTTPS: 'git clone https://github.com/econ-ark/HARK.git'.

2. Then, create and activate a [virtual environment](<[virtualenv]((https://virtualenv.pypa.io/en/latest/))>).
2. Then, create and activate a [virtual environment](https://virtualenv.pypa.io/en/latest/).

Install virtualenv if you need to and then type:

Expand Down
3 changes: 2 additions & 1 deletion Documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ you might want to look at the `DemARK
quick-start
ARKitecture
contributing/CONTRIBUTING.md
contributing/Installation_instruction.md
reference/index
CHANGELOG
license
Expand All @@ -36,7 +37,7 @@ you might want to look at the `DemARK
example_notebooks/GenIncProcessModel.ipynb
example_notebooks/LifecycleModel.ipynb
example_notebooks/HowWeSolveIndShockConsumerType.ipynb
example_notebooks/Journey_1_PhD.ipynb
example_notebooks/Journey-PhD.ipynb

Indices and tables
==================
Expand Down
Loading