Skip to content

RTD integration - #96

Open
t-ober wants to merge 13 commits into
masterfrom
to/#94-rtd-integration
Open

RTD integration#96
t-ober wants to merge 13 commits into
masterfrom
to/#94-rtd-integration

Conversation

@t-ober

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

Copy link
Copy Markdown
Contributor

Resolves #94

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

t-ober commented Feb 4, 2022

Copy link
Copy Markdown
Contributor Author

!test

Comment thread docs/readthedocs/_build/html/_static/jquery.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery-3.5.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery-3.5.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery-3.5.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery-3.5.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery-3.5.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery-3.5.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery-3.5.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery-3.5.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery-3.5.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery-3.5.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery.js Outdated
Comment thread docs/readthedocs/_build/html/_static/js/badge_only.js Outdated
Comment thread docs/readthedocs/_build/html/_static/js/html5shiv-printshiv.min.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery-3.5.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/jquery.js Outdated
Comment thread docs/readthedocs/_build/html/_static/underscore-1.13.1.js Outdated
Comment thread docs/readthedocs/_build/html/_static/underscore.js Outdated
Comment thread docs/readthedocs/_build/html/_static/js/html5shiv-printshiv.min.js Outdated
Comment thread docs/readthedocs/_build/html/_static/js/html5shiv.min.js Outdated
@sebastian-peter

sebastian-peter commented Feb 8, 2022

Copy link
Copy Markdown
Member

@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

ckittl commented Feb 11, 2022

Copy link
Copy Markdown
Member

@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 left a comment

Copy link
Copy Markdown
Member

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.

Comment thread docs/readthedocs/conf.py Outdated
Comment thread docs/readthedocs/conf.py
Comment thread docs/readthedocs/index.rst Outdated
@t-ober

t-ober commented Feb 12, 2022

Copy link
Copy Markdown
Contributor Author

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

ckittl commented Feb 14, 2022

Copy link
Copy Markdown
Member

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

@ckittl ckittl left a comment

Copy link
Copy Markdown
Member

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.

Comment thread docs/readthedocs/index.rst Outdated
t-ober and others added 2 commits February 14, 2022 17:53
Co-authored-by: Chris Kittl <44838605+ckittl@users.noreply.github.com>

@sebastian-peter sebastian-peter left a comment

Copy link
Copy Markdown
Member

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
Copy Markdown
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

sonatype-lift Bot commented Oct 12, 2022

Copy link
Copy Markdown

⚠️ 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

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add ReadTheDocs integration

3 participants