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

Fix #126: Provide tox.ini for documentation #127

Merged
merged 1 commit into from Sep 29, 2019
Merged

Fix #126: Provide tox.ini for documentation #127

merged 1 commit into from Sep 29, 2019

Conversation

tomschr
Copy link
Member

@tomschr tomschr commented Mar 24, 2019 •
edited

This PR contains the following change and fixes #126 :

  • Add "docs" target to run sphinx and output HTML
  • Provide docs/requirements.txt file
  • Fix typo in docs/conf.py

Some comments:

  • You could run the docs target through Travis, same as with the other targets. However, I wasn't sure if this would be useful for you, because you may create the doc with something else.
  • I've provided a separate requirements.txt file only for documentation. That way you can add whatever is needed without changing the tox.ini file.
  • The result of the build can be found at dist/docs.

@tomschr
Fix python-semver#126: Provide tox.ini for documentation
d5a7fa1 
* Add "docs" target to run sphinx and output HTML
* Provide docs/requirements.txt file
* Fix typo in docs/conf.py
@tomschr tomschr mentioned this pull request Mar 24, 2019
Closed
@tomschr
Copy link
Member Author

tomschr commented Sep 26, 2019

Any news on this PR? 😉 Do you need help?

ppkt
ppkt approved these changes Sep 26, 2019
View reviewed changes
Copy link
Member

@ppkt ppkt left a comment

Choose a reason for hiding this comment

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

lgfm :)

@scls19fr scls19fr merged commit c1ce5a1 into python-semver:master Sep 29, 2019
@tomschr tomschr deleted the tox-docs branch September 29, 2019 18:44
@tomschr tomschr mentioned this pull request Nov 3, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ppkt ppkt ppkt 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.

Missing target in tox.ini for building documentation
3 participants
@tomschr @ppkt @scls19fr