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

Add a readthedocs config file #289

Merged
merged 2 commits into from Mar 3, 2020
Merged

Add a readthedocs config file #289

merged 2 commits into from Mar 3, 2020

Conversation

davidfischer
Copy link
Contributor

Add a Read the Docs configuration file. This config file has a few advantages:

  • Versioning your Read the Docs build options (eg. the requirements file, Python version) rather than having those live only in the RTD dashboard.
  • There are some things that can only be configured in the config file although icalendar doesn't rely on them currently.

The current build on Read the Docs is failing. There are a few issues but I verified that this config file would solve them:

  • The docs requirements file isn't installed and so icalendar itself isn't installed. The docs build relies on this package being installed.
  • The requirements file specifies installing . which only works if pip install is run from the same directory.

This is an alternative to #262 and if this is merged that one can be closed.

@mister-roboto
Copy link

@davidfischer thanks for creating this Pull Request and help improve Plone!

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass.

Whenever you feel that the pull request is ready to be tested, either start all jenkins jobs pull requests by yourself, or simply add a comment in this pull request stating:

@jenkins-plone-org please run jobs

With this simple comment all the jobs will be started automatically.

Happy hacking!

@davidfischer davidfischer mentioned this pull request May 14, 2019
Closed
@davidfischer
Copy link
Contributor Author

@jenkins-plone-org please run jobs

@davidfischer
Copy link
Contributor Author

The Travis tests seem to pass although there's a timeout issue related to src/icalendar/tests/hypothesis/test_fuzzing.py. I don't believe that was introduced by this PR (other PRs suffer from it as well).

@UniversalSuperBox
Copy link
Contributor

@jenkins-plone-org please run jobs

UniversalSuperBox
UniversalSuperBox approved these changes Nov 15, 2019
View reviewed changes
Copy link
Contributor

@UniversalSuperBox UniversalSuperBox left a comment

Choose a reason for hiding this comment

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

It appears that the 3.7 build failed for unrelated reasons, and otherwise this looks fine (except the conflict on the changelog).

@UniversalSuperBox UniversalSuperBox mentioned this pull request Nov 25, 2019
Closed
@RagingRoosevelt RagingRoosevelt mentioned this pull request Mar 3, 2020
Closed
@mauritsvanrees
Copy link
Member

Thank you!
I love readthedocs, but I have never done the setup for a project there. And I don't really follow this repo either, except that I happen to do a release sometimes.
Seems worth a shot to merge this. I will do so.

@mauritsvanrees mauritsvanrees merged commit 21a2b30 into collective:master Mar 3, 2020
@wbob
Copy link

wbob commented Mar 3, 2020

as tests are still failing in the travis-ci/pr's fuzzing stage. I recommend to further reduce the max_examples setting, see issue #296

mauritsvanrees added a commit that referenced this pull request Mar 9, 2020
@mauritsvanrees
Tests: do less iterations with fuzzy contents.
d1ed9c4 
#289 (comment)
@mauritsvanrees mauritsvanrees mentioned this pull request Mar 9, 2020
Merged
@mauritsvanrees
Copy link
Member

https://icalendar.readthedocs.io/en/latest/ seems fine now. Great!

I have create a PR for the test failures: #309

mister-roboto pushed a commit to plone/buildout.coredev that referenced this pull request Mar 9, 2020
@mauritsvanrees
[fc] Repository: icalendar
b65fdd4 
Branch: refs/heads/master
Date: 2020-03-09T11:36:26+01:00
Author: Maurits van Rees (mauritsvanrees) <maurits@vanrees.org>
Commit: collective/icalendar@c65c6b7

Fixed error in tests with duplicate parameter 'self'.

TypeError: __init__() got multiple values for argument 'self'
https://travis-ci.org/collective/icalendar/jobs/659260349

Files changed:
M src/icalendar/tests/hypothesis/test_fuzzing.py
Repository: icalendar

Branch: refs/heads/master
Date: 2020-03-09T11:37:32+01:00
Author: Maurits van Rees (mauritsvanrees) <maurits@vanrees.org>
Commit: collective/icalendar@d1ed9c4

Tests: do less iterations with fuzzy contents.

collective/icalendar#289 (comment)

Files changed:
M src/icalendar/tests/hypothesis/test_fuzzing.py
Repository: icalendar

Branch: refs/heads/master
Date: 2020-03-09T21:44:59+01:00
Author: Maurits van Rees (mauritsvanrees) <m.van.rees@zestsoftware.nl>
Commit: collective/icalendar@2cc1dac

Merge pull request #309 from collective/maurits/improve-testing

Maurits/improve testing

Files changed:
M src/icalendar/tests/hypothesis/test_fuzzing.py
mister-roboto pushed a commit to plone/buildout.coredev that referenced this pull request Mar 9, 2020
@mauritsvanrees
[fc] Repository: icalendar
c29a844 
Branch: refs/heads/master
Date: 2020-03-09T11:36:26+01:00
Author: Maurits van Rees (mauritsvanrees) <maurits@vanrees.org>
Commit: collective/icalendar@c65c6b7

Fixed error in tests with duplicate parameter 'self'.

TypeError: __init__() got multiple values for argument 'self'
https://travis-ci.org/collective/icalendar/jobs/659260349

Files changed:
M src/icalendar/tests/hypothesis/test_fuzzing.py
Repository: icalendar

Branch: refs/heads/master
Date: 2020-03-09T11:37:32+01:00
Author: Maurits van Rees (mauritsvanrees) <maurits@vanrees.org>
Commit: collective/icalendar@d1ed9c4

Tests: do less iterations with fuzzy contents.

collective/icalendar#289 (comment)

Files changed:
M src/icalendar/tests/hypothesis/test_fuzzing.py
Repository: icalendar

Branch: refs/heads/master
Date: 2020-03-09T21:44:59+01:00
Author: Maurits van Rees (mauritsvanrees) <m.van.rees@zestsoftware.nl>
Commit: collective/icalendar@2cc1dac

Merge pull request #309 from collective/maurits/improve-testing

Maurits/improve testing

Files changed:
M src/icalendar/tests/hypothesis/test_fuzzing.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@UniversalSuperBox UniversalSuperBox UniversalSuperBox approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@davidfischer @mister-roboto @UniversalSuperBox @mauritsvanrees @wbob