Add auto-generated documentation site with pydoctor. #53
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can you please rebase on the current master? |
pschmitt
reviewed
Jun 30, 2022
| @@ -244,7 +244,9 @@ def run_job_by_name(self, name, *args, **kwargs): | |||
| return self.run_job(job["id"], *args, **kwargs) | |||
|
|
|||
| def get_executions_for_job(self, job_id=None, job_name=None, **kwargs): | |||
| # http://rundeck.org/docs/api/#getting-executions-for-a-job | |||
| """ | |||
| `Docs <https://docs.rundeck.com/docs/api/rundeck-api.html#getting-executions-for-a-job>`_ | |||
pschmitt
reviewed
Jun 30, 2022
| - name: Set up Python 3.8 | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: 3.8 |
There was a problem hiding this comment.
No reason, please feel free to change it.
|
Hi @pschmitt, Note that you will have to enable Github pages on the repo for it to be served. The flake8 rule about 80 characters max might pose issues for docstrings, though. Even if ReStruturedText allows to wrap links on several lines, it will be harder for viewers that reads the source code to go to that link, because IDE environment usually don't support wrapping link in several lines. Tell me what you think, |
|
Hm. There's gotta be a way to noqa the dostrings |
|
There is a way: twisted/pydoctor#673 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Looks like this: https://tristanlatr.github.io/pyrundeck/