Skip to content
This repository has been archived by the owner on Dec 1, 2021. It is now read-only.

Remove error from make html doc and update converter doc using Sphinx-apidoc #989

Merged
merged 4 commits into from
Apr 16, 2020

Conversation

oatawa1
Copy link
Contributor

@oatawa1 oatawa1 commented Apr 14, 2020

What this patch does to fix the issue.

Remove error when generate doc using make html which mainly from reference error.

  • For converter update using autogenerate from Sphinx-apidoc.
  • For optimization.rst, I fix it but I think this file is obsolete. Shall we remove it?: removed

Link to any relevant issues or pull requests.

#953 (Error part)
The warning part will be solved in another PR to reduce the amount of commit code.

@oatawa1 oatawa1 added bug Something isn't working documentation labels Apr 14, 2020
@oatawa1 oatawa1 requested a review from iizukak April 14, 2020 08:42
@oatawa1 oatawa1 self-assigned this Apr 14, 2020
@blueoil-butler blueoil-butler bot added the CI: auto-run Run CI automatically label Apr 14, 2020
@bo-code-review-bot
Copy link

This PR needs Approvals as follows.

  • Ownership Approval for / from iizukak, tkng, ruimashita

Please choose reviewers and requet reviews!

Click to see how to approve each reviews

You can approve this PR by triggered comments as follows.

  • Approve all reviews requested to you (readability and ownership) and LGTM review
    Approval, LGTM

  • Approve all ownership reviews
    Ownership Approval or OA

  • Approve all readability reviews
    Readability Approval or RA

  • Approve specified review targets

    • Example of Ownership Reviewer of /: Ownership Approval for / or OA for /
    • Example of Readability Reviewer of Python: Readability Approval for Python or RA for Python
  • Approve LGTM review
    LGTM

See all trigger comments

Please replace [Target] to review target

  • Ownership Approval
    • Ownership Approval for [Target]
    • OA for [Target]
    • Ownership Approval
    • OA
    • Approval
  • Readability Approval
    • Readability Approval for [Target]
    • RA for [Target]
    • [Target] Readability Approval
    • [Target] RA
    • Readability Approval
    • RA
    • Approval
  • LGTM
    • LGTM
    • lgtm

@iizukak
Copy link
Member

iizukak commented Apr 14, 2020

@oatawa1 Thanks. We can remove optimization.rst,

@oatawa1
Copy link
Contributor Author

oatawa1 commented Apr 15, 2020

@iizukak Thanks. I removed it in the latest commit

@oatawa1
Copy link
Contributor Author

oatawa1 commented Apr 15, 2020

The deployment version is different from the local test version. I will fix it

Copy link
Member

@iizukak iizukak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OA

@oatawa1
Copy link
Contributor Author

oatawa1 commented Apr 15, 2020

@iizukak Thanks.

Can I merge this PR?

The current problem is the current deployment version show only the class name it should show both class name along with module and arg name.
https://deploy-preview-989--blueoil.netlify.com/converter/converter.core.html

In my opinion, I want to merge this one to fix the error problem.
Then, this Python API will be removed in #995 , because I will migrate the Python API doc to autogenerate.

@bo-code-review-bot
Copy link

This PR needs Approvals as follows.

  • Readability Approval for Python from tkng, tsawada, tfujiwar

Please choose reviewers and requet reviews!

Click to see how to approve each reviews

You can approve this PR by triggered comments as follows.

  • Approve all reviews requested to you (readability and ownership) and LGTM review
    Approval, LGTM

  • Approve all ownership reviews
    Ownership Approval or OA

  • Approve all readability reviews
    Readability Approval or RA

  • Approve specified review targets

    • Example of Ownership Reviewer of /: Ownership Approval for / or OA for /
    • Example of Readability Reviewer of Python: Readability Approval for Python or RA for Python
  • Approve LGTM review
    LGTM

See all trigger comments

Please replace [Target] to review target

  • Ownership Approval
    • Ownership Approval for [Target]
    • OA for [Target]
    • Ownership Approval
    • OA
    • Approval
  • Readability Approval
    • Readability Approval for [Target]
    • RA for [Target]
    • [Target] Readability Approval
    • [Target] RA
    • Readability Approval
    • RA
    • Approval
  • LGTM
    • LGTM
    • lgtm

@oatawa1 oatawa1 added the CI: test-dlk Run dlk test once label Apr 15, 2020
@blueoil-butler blueoil-butler bot removed the CI: test-dlk Run dlk test once label Apr 15, 2020
@oatawa1
Copy link
Contributor Author

oatawa1 commented Apr 16, 2020

The problem of class definition and parameter disappeared in deployment is fixed in #995 . So I merged this PR first so I can make #995 ready.

@oatawa1
Copy link
Contributor Author

oatawa1 commented Apr 16, 2020

/ready

@bo-mergebot
Copy link
Contributor

bo-mergebot bot commented Apr 16, 2020

⏳Merge job is queued...

@bo-mergebot bo-mergebot bot merged commit cd303bc into blue-oil:master Apr 16, 2020
@oatawa1 oatawa1 deleted the fix-doc-error branch April 16, 2020 02:45
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working CI: auto-run Run CI automatically documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants