readthedocs example

[chayim]

Python projects publish to readthedocs. Unfortunately, we don't currently. These changes are an example of how rejson can publish to readthedocs. This merely starts the process - and the proposal is that we get this approach into all module clients.

This change generates documents locally from the rejson source code. readthedocs will need changes (and a project) to make use of this, but this is what I'm proposing. To test locally you must have python 3.7, pip, and gnu make installed. This PR relies on standard tools and pure python (i.e sphinx)

1. Create a new virtualenv, with python > 3.7 (python -m venv venvname)
2. Activate your virtualenv (source venvname/bin/activate)
3. Install all dependencies (poetry install)
4. Build the documents from the tip of the repo (make html)

Finally, to view the documents as they would appear on readthedocs:

1. cd dist/docs/html
2. python3 -m http.server

Open your browser to the port listed in the console.

[lgtm-com[bot]]

This pull request introduces 1 alert when merging 24e4e4d3e0091e2f48f809f9ddff0f70edaa3566 into b6fa063fe8fa617509681677f78c5243718b90f8 - view on LGTM.com

new alerts:

• 1 for Except block handles 'BaseException'

[lgtm-com[bot]]

This pull request introduces 1 alert when merging 470936da9d3b5e53946c83ba7473f10ea02a6354 into b6fa063fe8fa617509681677f78c5243718b90f8 - view on LGTM.com

new alerts:

• 1 for Except block handles 'BaseException'

[lgtm-com[bot]]

This pull request introduces 1 alert when merging 8bfb29c6091f1bf0cda55d0e6bca16fe6c27165a into b6fa063fe8fa617509681677f78c5243718b90f8 - view on LGTM.com

new alerts:

• 1 for Except block handles 'BaseException'

[lgtm-com[bot]]

This pull request introduces 1 alert when merging 52ce7ed69d25b451f14d7e6064f6c686cbf66ed8 into 235d658cde848e66da657ab00c738e761c5882ec - view on LGTM.com

new alerts:

• 1 for Except block handles 'BaseException'

[sonarcloud[bot]]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

[lgtm-com[bot]]

This pull request introduces 1 alert when merging 8fcd34634d8a84d7fc48cbd9cf332ec912553211 into e97a42b8c81a56984b04935b3cbde90251fcb5cb - view on LGTM.com

new alerts:

• 1 for Except block handles 'BaseException'