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

DOCS-#4082: Add pdf/epub/htmlzip formats for doc builds #4083

Merged
merged 2 commits into from
Jan 28, 2022
Merged

DOCS-#4082: Add pdf/epub/htmlzip formats for doc builds #4083

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e769481
DOCS-#4082: Add `pdf`/`epub`/`htmlzip` formats for doc builds
prutskov Jan 27, 2022
4fe1443
Add username to Contributors
prutskov Jan 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ build:
sphinx:
configuration: docs/conf.py

formats: all

python:
install:
- requirements: docs/requirements-doc.txt
1 change: 1 addition & 0 deletions docs/release_notes/release_notes-0.14.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Key Features and Updates
*
* Documentation improvements
* DOCS-#4077: Add release notes template to docs folder (#4078)
* DOCS-#4082: Add pdf/epub/htmlzip formats for doc builds (#4083)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@RehanSD I've added a type/issue number/PR name/ PR number as it's described in example above. But I didn't find an example where I should place my github username. Should it be placed in "Contributors" section or not? Example doesn't show where I should put it

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes please! For context, this is the release description you see here, so please add your name to the Contributors section with an @ so GitHub can also auto link your profile!

Copy link
Collaborator

Choose a reason for hiding this comment

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

Type/Issue/Pr Title + Number look perfect! I suspect Devin forgot to add his name to the contributors, which I'll fix when I add my docs fix PR that got merged last night to this template!

* Dependencies
*

Expand Down