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

RTD integration #96

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

RTD integration #96

wants to merge 13 commits into from

Conversation

t-ober
Copy link
Contributor

@t-ober t-ober commented Feb 4, 2022

Resolves #94

@t-ober t-ober added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 4, 2022
@t-ober
Copy link
Contributor Author

t-ober commented Feb 4, 2022

!test

@sebastian-peter
Copy link
Member

sebastian-peter commented Feb 8, 2022 •
edited
Loading

@t-ober The build output of sphinx should not be committed, right?
You could just simply add this to .gitignore:

# Read the docs build output
docs/readthedocs/_build

@ckittl
Copy link
Member

ckittl commented Feb 11, 2022

@t-ober The build output of sphinx should not be committed, right? You could just simply add this to .gitignore:

# Read the docs build output
docs/readthedocs/_build

Definately would decrease the amount of code smells. ^^

ckittl
ckittl suggested changes Feb 11, 2022
View reviewed changes
Copy link
Member

@ckittl ckittl left a comment

Choose a reason for hiding this comment

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

Thanks for the introduction of rtd! Please remove the _build directory as suggested by @sebastian-peter.

docs/readthedocs/conf.py Outdated Show resolved Hide resolved
docs/readthedocs/conf.py Show resolved Hide resolved
docs/readthedocs/index.rst Outdated Show resolved Hide resolved
@t-ober
Copy link
Contributor Author

t-ober commented Feb 12, 2022

We still need to take care of updating the java version so sonarqube does his job

@t-ober t-ober requested a review from ckittl February 12, 2022 07:14
@ckittl
Copy link
Member

ckittl commented Feb 14, 2022

We still need to take care of updating the java version so sonarqube does his job

Would rather start with a proper documentation and then changing Java version.

ckittl
ckittl previously requested changes Feb 14, 2022
View reviewed changes
Copy link
Member

@ckittl ckittl left a comment

Choose a reason for hiding this comment

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

Sorry, that directly touched my eye. ^^

And please double-check the config entry for version / release.

docs/readthedocs/index.rst Outdated Show resolved Hide resolved
@ckittl ckittl mentioned this pull request Feb 14, 2022
Closed
t-ober and others added 2 commits February 14, 2022 17:53
@t-ober @ckittl
Update docs/readthedocs/index.rst
0d54976 
Co-authored-by: Chris Kittl <44838605+ckittl@users.noreply.github.com>
@t-ober
adjust conf.py version
5b6e175
@t-ober t-ober requested a review from ckittl February 14, 2022 16:58
@t-ober t-ober mentioned this pull request Mar 31, 2022
Open
sebastian-peter
sebastian-peter approved these changes Apr 5, 2022
View reviewed changes
Copy link
Member

@sebastian-peter sebastian-peter left a comment

Choose a reason for hiding this comment

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

Looks good, thank you!

@sebastian-peter
Copy link
Member

How do you feel about introducing a CHANGELOG.md here as well? @t-ober

@t-ober t-ober dismissed ckittl’s stale review October 12, 2022 12:57

Not here anymore :(

@sonatype-lift
Copy link

sonatype-lift bot commented Oct 12, 2022

⚠️ 2 God Classes were detected by Lift in this project. Visit the Lift web console for more details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sonatype-lift sonatype-lift[bot] sonatype-lift[bot] left review comments

@johanneshiry johanneshiry Awaiting requested review from johanneshiry

@ckittl ckittl Awaiting requested review from ckittl

@sebastian-peter sebastian-peter Awaiting requested review from sebastian-peter

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add ReadTheDocs integration
3 participants
@t-ober @sebastian-peter @ckittl