Skip to content

Commit a4ad745

Browse files
authored
docs: fix links and improve contributions guideline (#1191)
Signed-off-by: behnazh-w <[email protected]>
1 parent 5e3fac8 commit a4ad745

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Please see the [README for the malware analyzer](./src/macaron/malware_analyzer/
8484

8585
### Prerequisites
8686

87-
- Python 3.11
87+
- Python 3.11.13
8888
- Go 1.23
8989
- JDK 17
9090

@@ -229,7 +229,7 @@ $ make integration-test
229229

230230
## Generating documentation
231231

232-
As mentioned above, all package code should make use of [Python docstrings](https://www.python.org/dev/peps/pep-0257/) in [reStructured text format](https://www.python.org/dev/peps/pep-0287/) following [numpydoc style](https://numpydoc.readthedocs.io/en/latest/format.html) (with some exceptions - see our [style guide](https://oracle.github.io/pages/developers_guide/style_guide.html#docstrings)). Using these docstrings and the documentation template in the `docs/source/` folder, you can then generate proper documentation in different formats using the [Sphinx](https://github.com/sphinx-doc/sphinx/) tool:
232+
As mentioned above, all package code should make use of [Python docstrings](https://www.python.org/dev/peps/pep-0257/) in [reStructured text format](https://www.python.org/dev/peps/pep-0287/) following [numpydoc style](https://numpydoc.readthedocs.io/en/latest/format.html) (with some exceptions - see our [style guide](https://oracle.github.io/macaron/pages/developers_guide/style_guide.html#docstrings)). Using these docstrings and the documentation template in the `docs/source/` folder, you can then generate proper documentation in different formats using the [Sphinx](https://github.com/sphinx-doc/sphinx/) tool:
233233

234234
```bash
235235
make docs

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ python -m http.server -d docs/_build/html
1818

1919
## Extend the API reference
2020

21-
We use the [sphinx-apidoc](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html) tool to generate API reference automatically from Python docstrings. See the [Docstring section in the Macaron Style Guide](https://oracle.github.io/pages/developers_guide/style_guide.html#docstrings) for how to write docstrings in Macaron.
21+
We use the [sphinx-apidoc](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html) tool to generate API reference automatically from Python docstrings. See the [Docstring section in the Macaron Style Guide](https://oracle.github.io/macaron/pages/developers_guide/style_guide.html#docstrings) for how to write docstrings in Macaron.
2222

2323
If you make a code change, make sure to regenerate the API reference by running (with the dev environment activated):
2424

0 commit comments

Comments
 (0)