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.

Sign up for GitHub

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

Jump to bottom

Create the document and run the test to create document in each PR #2

Merged
merged 13 commits into from
Mar 28, 2023
Merged

Create the document and run the test to create document in each PR #2

merged 13 commits into from
Mar 28, 2023

Conversation

HideakiImamura
Copy link
Member

Motivation

The current optuna-integration module does not have any documents. This PR aims to add the document using Read The Docs, and add a workflow to run the test to create document in each PR.

Description of the changes

  • Add docs directory to build the document
  • Add .github/workflows/sphinx-build.yml to run the CI

@HideakiImamura
Copy link
Member Author

The latest build document is here.

@HideakiImamura
Copy link
Member Author

I will do the following as follow-ups.

  • Transfer https://optuna-integration.readthedocs.io/ from HideakiImamura/optuna-integration to optuna/optuna-integration.
  • Enable showing build document in each PR. See here for more details.

@HideakiImamura
Copy link
Member Author

@gen740 Could you review this PR?

@github-actions
Copy link

This pull request has not seen any recent activity.

@github-actions github-actions bot added the stale Exempt from stale bot labeling. label Mar 22, 2023
gen740
gen740 reviewed Mar 24, 2023
View reviewed changes
Copy link
Collaborator

@gen740 gen740 left a comment

Choose a reason for hiding this comment

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

Almost LGTM! I left a minor comment.

docs/source/reference/index.rst Outdated Show resolved Hide resolved
@gen740
Copy link
Collaborator

gen740 commented Mar 24, 2023 •
edited

There seems to be something wrong with coverage ci. Coverage is broken.

@github-actions github-actions bot removed the stale Exempt from stale bot labeling. label Mar 26, 2023
@HideakiImamura @gen740
Update docs/source/reference/index.rst
708c8cb 
Co-authored-by: Gen <54583542+gen740@users.noreply.github.com>
@HideakiImamura
Copy link
Member Author

@gen740 Thanks for the review. I applied your suggestion. PTAL.

There seems to be something wrong with coverage ci. Coverage is broken.

Agree. It should be fixed, but there is nothing to do with the current PR. Let's discuss this outside this PR.

gen740
gen740 approved these changes Mar 28, 2023
View reviewed changes
Copy link
Collaborator

@gen740 gen740 left a comment

Choose a reason for hiding this comment

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

LGTM!

@gen740 gen740 merged commit 34881fe into optuna:main Mar 28, 2023
@HideakiImamura HideakiImamura added the document Documentation related. label May 18, 2023
@HideakiImamura HideakiImamura added this to the v3.2.0 milestone May 18, 2023
not522 pushed a commit that referenced this pull request Jan 10, 2024
@dheemantha-bhat
Merge pull request #2 from dheemantha-bhat/tensorboard
121e77f 
Fixed formatting
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gen740 gen740 gen740 approved these changes

Assignees

@gen740 gen740

Labels
document Documentation related.
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@HideakiImamura @gen740