infrastructure/python-gitlab-management
2
0
Fork 0
Code Issues Pull Requests Actions Projects Releases 29 Wiki Activity

Module documentation not available on readthedocs.io #13

New Issue
Closed
opened 2020-06-21 05:59:04 +00:00 by jon_nfc · 26 comments
jon_nfc commented 2020-06-21 05:59:04 +00:00 (Migrated from gitlab.com)
Copy Link

Summary

documentation at https://python-gitlab-management.readthedocs.io not displaying the module documentation.

Version 0.1.2.rc2006061112 was the last version to display the module documentation. no subsequent version displays the module docs.

Steps to reproduce

What is the current bug behavior?

The module docs are not generated on readthedocs.io. (does work for local build)

What is the expected correct behavior?

module documentation is created on readthedocs.io

Relevant logs and/or screenshots

Possible fixes

  • *UKN - * sys import path?

Details

  • Module Version: All after 0.1.2.rc2006061112
  • Python Version: 3.6.9
  • Environment: readthedocs.io build server

Tasks

  • ~Documentation, documentation changes completed (if applicable)
  • ~"bug::reproducable" ??
## Summary documentation at https://python-gitlab-management.readthedocs.io not displaying the module documentation. Version [0.1.2.rc2006061112](https://python-gitlab-management.readthedocs.io/en/0.1.2.rc2006061112/module/modules.html) was the last version to display the module documentation. no subsequent version displays the module docs. ## Steps to reproduce <!-- How one can reproduce the issue - this is very important --> ### What is the current *bug* behavior? The module docs are not generated on readthedocs.io. *(does work for local build)* ### What is the expected *correct* behavior? module documentation is created on readthedocs.io ## Relevant logs and/or screenshots * [Comparison of commits where the change occured](https://gitlab.com/nofusscomputing/projects/python-gitlab-management/-/compare/5e3cd9ba1fa884e28eaad6cc7c03d62cc60faec5...ff99a5594f4c89858eb629856a7097f09e9d0391) * discovered after MR !5 ## Possible fixes * *UKN - * sys import path? ## Details * **Module Version:** *All after 0.1.2.rc2006061112* * **Python Version:** *3.6.9* * **Environment:** *readthedocs.io build server* ## Tasks <!-- List any additional to do tasks under here:--> * [ ] ~Documentation, documentation changes completed *(if applicable)* * [x] ~"bug::reproducable" ??
jon_nfc commented 2020-06-21 05:59:22 +00:00 (Migrated from gitlab.com)
Copy Link

created merge request !11 to address this issue

created merge request !11 to address this issue
jon_nfc commented 2020-06-21 05:59:22 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in merge request !11

mentioned in merge request !11
jon_nfc commented 2020-06-21 06:12:59 +00:00 (Migrated from gitlab.com)
Copy Link

__init__.py was removed from repo, check to see that the doc build process is calling buildinit.py to generate

`__init__.py` was removed from repo, check to see that the doc build process is calling `buildinit.py` to generate
jon_nfc commented 2020-06-21 06:12:59 +00:00 (Migrated from gitlab.com)
Copy Link

added 20m of time spent at 2020-06-21

added 20m of time spent at 2020-06-21
jon_nfc commented 2020-06-21 06:14:39 +00:00 (Migrated from gitlab.com)
Copy Link

assigned to @jon_nfc

assigned to @jon_nfc
jon_nfc commented 2020-06-21 07:06:56 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit 14ae35d0ae

mentioned in commit 14ae35d0ae14d4a70b2fe2482c9f655695a75708
jon_nfc commented 2020-06-21 07:06:56 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit 44a8b1bec7

mentioned in commit 44a8b1bec7358843fb3c7d6e06d381a076571acf
jon_nfc commented 2020-06-21 07:06:56 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit e2a9e360a8

mentioned in commit e2a9e360a86a228e22beb220f8fccd3f582d3f45
jon_nfc commented 2020-06-21 07:06:56 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit 0e84184915

mentioned in commit 0e84184915981ba32b4a1cf38fcd37d74f8f0798
jon_nfc commented 2020-06-21 07:06:56 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit 27589eb0df

mentioned in commit 27589eb0dfb3cfe8421b9ea8021f56d969b6330f
jon_nfc commented 2020-06-21 07:07:07 +00:00 (Migrated from gitlab.com)
Copy Link

marked the checklist item ~"bug::reproducable" ?? as completed

marked the checklist item **~"bug::reproducable" ??** as completed
jon_nfc commented 2020-06-21 07:07:20 +00:00 (Migrated from gitlab.com)
Copy Link

changed the description

changed the description
jon_nfc commented 2020-06-21 07:08:38 +00:00 (Migrated from gitlab.com)
Copy Link

Notes

~"bug::reproducable" locally this has been confirmed as the ~Bug. However a build on buildthedocs.io will have to be run to confirm.

## Notes ~"bug::reproducable" locally this has been confirmed as the ~Bug. However a build on buildthedocs.io will have to be run to confirm.
jon_nfc commented 2020-06-21 07:08:51 +00:00 (Migrated from gitlab.com)
Copy Link

added 1h 13m of time spent at 2020-06-21

added 1h 13m of time spent at 2020-06-21
jon_nfc commented 2020-06-21 07:29:00 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit cdc68df994

mentioned in commit cdc68df9947da4b5192bbfcfabd28e61c51701d9
jon_nfc commented 2020-06-21 07:29:00 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit 19aba6be42

mentioned in commit 19aba6be42addb633c40a261e90cf92406608bf9
jon_nfc commented 2020-06-21 07:58:09 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit 47894febd9

mentioned in commit 47894febd98ca52a91be69ecf48c17b1c9525d5c
jon_nfc commented 2020-06-21 07:58:09 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit b276697ae2

mentioned in commit b276697ae2f49ef8c717bf5ada2ae43441d9240d
jon_nfc commented 2020-06-21 07:58:09 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit f17784d1a9

mentioned in commit f17784d1a91eb8ab27eeb3a45bb01bbd7713f056
jon_nfc commented 2020-06-21 08:16:55 +00:00 (Migrated from gitlab.com)
Copy Link

Confirmed

~Bug is ~"bug::reproducable". confirmed on readthedocs.io that the init file wasn't being created

now the __init__.py is created during the build process, both locally and on readthedocs

## Confirmed ~Bug is ~"bug::reproducable". confirmed on `readthedocs.io` that the init file wasn't being created now the `__init__.py` is created during the build process, both locally and on `readthedocs`
jon_nfc commented 2020-06-21 08:16:55 +00:00 (Migrated from gitlab.com)
Copy Link

added 1h 15m of time spent at 2020-06-21

added 1h 15m of time spent at 2020-06-21
jon_nfc commented 2020-06-21 08:32:34 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in merge request !12

mentioned in merge request !12
jon_nfc commented 2020-06-21 08:33:59 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit 502e24e4f2

mentioned in commit 502e24e4f20a6c94c06b0f31b3bac7c2b27d1772
jon_nfc commented 2020-06-21 09:58:07 +00:00 (Migrated from gitlab.com)
Copy Link

closed via merge request !12

closed via merge request !12
jon_nfc commented 2020-06-21 10:17:57 +00:00 (Migrated from gitlab.com)
Copy Link

!13 created to merge to master after merg conflict chaos

!13 created to merge to `master` after merg conflict chaos
jon_nfc commented 2020-06-21 10:25:53 +00:00 (Migrated from gitlab.com)
Copy Link

mentioned in commit 53c89d47e4

mentioned in commit 53c89d47e4fe2829aba9b2ea0280744c01e47e50
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Bug
Used in discussion about a bug in comments or commits
CVE-2023-5764
Denotes items related to the CVE
CodeReview
Used in comments (issues/MR/commits) to denote code review related items
Documentation
Documentation items
Feature
Used in discussion about a Feature in comments or commits
Lint
Used in comments (issues/MR/commits) to denote lint tasks todo, done, fixed
Privacy
Used in comments (issues/MR/commits) to denote privacy related items
Security
Used in comments (issues/MR/commits) to denote Security related items
breaking-change
label used to denote that the issue/Merge Request does/will introduce a breaking change
bug::reproducable
Given to an issue when the bug has been confirmed as re-producable. Can also be used in comments and commits.
bug::unable to reproduce
Given to an issue when the bug that is not able to be reproduced. Can also be used in comments and commits.
code review::complete
code review::not started
code review::rejected
code review::underway
difficulty::Full Development
Level 3. Difficulty representing that the task to complete must be planned and created.
difficulty::Good First Issue
Level 1. Difficulty representing that the task is very simple and with limited knowledge can be completed.
difficulty::Prior Knowledge
Level 2. Difficulty representing that the task requires some prior knowledge of either the technology or the project for task completion.
documentation::complete
Issues, Merge Requests
documentation::no change required
Issues, Merge Requests and used to denote no documentation changes required
documentation::not started
Issues, Merge Requests
documentation::stalled
Issues, Merge Requests
documentation::underway
Issues, Merge Requests
impact::0
impact::1
impact::2
impact::3
impact::4
impact::5
ops::ansible-roles
OPS project tag
ops::automation
ops::gitlab-ci
OPS project tag
ops::marcas
OPS project tag
ops::python-gitlab-management
OPS project tag
ops::website
priority::0
priority::1
priority::2
priority::3
priority::4
priority::5
stage::Ready for Development
stage::develop
Stage for use in Issues and Merge Requests. Can also be used in discussion in comments and commits
stage::feedback required
stage::planning
Stage for use in Issues and Merge Requests. Can also be used in discussion in comments and commits
stage::test
Stage for use in Issues and Merge Requests. Can also be used in discussion in comments and commits
stale
Label given to issues/merge requests that are considered stale due to no collaboration and is a mark for closure.
triage
Tag given to issues/merge requests requiring triaging by the team.
triage::not_confidential
This tag is given by the triage bot so that URLs can be added to an issue/comment. A triage policy for NFC wide should remove this label.
type::CI / CD
type::automation
This type is used to denote an automation job
type::bug
Type for Issues and Merge Requests. Can also be used in discussion in comments and commits
type::compliance
type::discussion
Type for Issues. Can also be used in discussion in comments.
type::documentation
Type for Issues and Merge Requests. Can also be used in discussion in comments and commits
type::feature
type for Issues and Merge Requests. Can also be used in discussion in comments and commits
type::invalid
label given to tickets that require no action or are deem as invalid.
type::quality assurance
Type for Issues and Merge Requests. Can also be used in discussion in comments and commits
type::question
Type for Issues. Can also be used in discussion in comments.
type::security
Type for Issues and Merge Requests.
type::specification
Design specification
workflow::complete
Issues, Merge Requests
workflow::not ready
workflow::not ready::blocked
workflow::not started
Issues, Merge Requests
workflow::ready to commence
Issues, Merge Requests
workflow::stalled
Label given to issues/merge requests where no work has occured in x days iaw triage policy.
workflow::underway
Issues, Merge Requests
workflow::underway::develop
Area/CI-CD
Documentation changes
Area/Documentation
Documentation changes
Area/Security
This is security issue
Area/Testing
Issue or pull request related to testing
Bug
Failure to Confirm
Bug exists due to not confirming/testing code
Bug
Regression
THe bug is a regression of a feature
Bug
To be Confirmed
This bug is not confirmed
Bug
Unable to Reproduce
A developer can not re-create/re-produce the bug
Compat/Breaking
Breaking change that won't be backward compatible
Impact
Critical
1
The impact is critical in that it is blocking or prevents usage.
Impact
High
2
The impact requires that changes be made for continuted usage.
Impact
Low
4
The impact requires the user approach from a different angle for continued usage.
Impact
Medium
3
The impact requires a workaround for continued usage.
Impact
Very Low
5
The impact has a slight effect on usage.
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Priority
Very High
1
The priority is critical
Priority
Very Low
5
The priority is very low
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
Type
Bug
Something is not working
Type
Epic
Epic User Story
Type
Feature
Feature / Module
Type
Incident
Something occured related to a service
Type
RFE
Request for Enhancement
Type
Task
A work item that must be done
Urgency
Low
4
Prioritize this amoungst your list of things to do.
Urgency
Major
1
Urgency is so high it should have been dealt with last week.
Urgency
Medium
3
Start as soon as possible.
Urgency
Very High
2
Urgency is high enough to warrant near immediate commencement.
Urgency
Very Low
5
Add this to your list of things to do.
No Label
Bug
documentation::no change required
stage::develop
workflow::complete
Milestone
No items
No Milestone Version 1.0.0
Projects
Clear projects
No project
Assignees
Clear assignees
jason jon
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: infrastructure/python-gitlab-management#13
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?