f4pga / f4pga/f4pga-arch-defs

Make all the Python files importable

Open
#61 2 comments 0 reactions 0 assignees View on GitHub
help wanted lang-python
Dominant language
Jupyter Notebook
Stars
314
Forks
121
PR merge metrics
No merged PRs in 30d

Description

For Sphinx documentation we need the Python files to be importable. The way to do this is to;

* Put all the current stuff under a `def main(args)` function.
* Put the following at the end;
```python
if __name__ == "__main__":
import sys
sys.exit(main(sys.argv))
```

The argument set up should remain at the top level so it can be automatically converted to help documentation.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.