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

docs: automatically create reference pages for the python library #386

Conversation

lars-reimann
Copy link
Member

@lars-reimann lars-reimann commented Jan 27, 2023

Closes #385.

Summary of Changes

  • Remove manually created API reference pages.
  • Instead add a script the automatically creates them, so changes to the API are immediately reflected in the documentation.

@lars-reimann lars-reimann linked an issue Jan 27, 2023 that may be closed by this pull request
@github-actions
Copy link

github-actions bot commented Jan 27, 2023

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ PYTHON bandit 1 0 0.46s
✅ PYTHON black 1 0 0 0.43s
✅ PYTHON flake8 1 0 0.31s
✅ PYTHON isort 1 0 0 0.26s
✅ PYTHON mypy 1 0 1.61s
✅ PYTHON pylint 1 0 2.15s
✅ YAML prettier 1 0 0 0.47s
✅ YAML v8r 1 0 2.08s
✅ YAML yamllint 1 0 0.19s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@lars-reimann lars-reimann mentioned this pull request Jan 27, 2023
16 tasks
@lars-reimann lars-reimann force-pushed the 385-automatically-create-reference-pages-for-the-python-library branch from 6b6b556 to 03bf4cd Compare January 27, 2023 20:44
@lars-reimann lars-reimann force-pushed the 385-automatically-create-reference-pages-for-the-python-library branch from 70852d1 to ceeaa93 Compare January 27, 2023 20:53
@lars-reimann lars-reimann merged commit 641a966 into main Jan 27, 2023
@lars-reimann lars-reimann deleted the 385-automatically-create-reference-pages-for-the-python-library branch January 27, 2023 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automatically create reference pages for the Python library
1 participant