1
1
Preview Documentation from Pull Requests
2
2
========================================
3
3
4
- Read the Docs allows you to build and preview your documentation from pull/merge requests.
5
- To enable this feature:
4
+ Read the Docs allows you to build and preview your documentation from pull requests.
5
+ To enable this feature:
6
6
7
7
#. Go to your project dashboard
8
8
#. Go to :guilabel: `Admin > Advanced settings `
@@ -12,17 +12,17 @@ To enable this feature:
12
12
Features
13
13
--------
14
14
15
- - **Build on Pull/Merge Request Events: ** We create and build a new version when a pull/merge request is open,
15
+ - **Build on Pull Request Events: ** We create and build a new version when a pull request is open,
16
16
and when a new commit has been pushed.
17
17
18
+ - **Build Status Report: ** When a build is triggered, a build pending notification is sent with a link to the build log.
19
+ When the build finishes we send a success notification with the link to the preview or a failure notification with a link to the build log.
20
+
18
21
- **Warning Banner: ** A warning banner is shown at the top of the documentation
19
22
to let users know that this isn't the main documentation for the project.
20
23
21
24
.. note :: This feature is available only for :doc:`Sphinx projects </intro/getting-started-with-sphinx>`.
22
25
23
- - **Build Status Report: ** When a build is triggered, a build pending notification is sent with a link to the build log.
24
- When the build finishes we send a success notification with the link to the preview or a failure notification with a link to the build log.
25
-
26
26
.. figure :: /_static/images/github-build-status-reporting.gif
27
27
:align: center
28
28
:alt: GitHub Build Status Reporting for Pull Requests.
@@ -38,20 +38,20 @@ Privacy levels
38
38
39
39
Privacy levels are only supported on :doc: `/commercial/index `.
40
40
41
- All docs built from a pull/merge requests are private by default.
41
+ All docs built from a pull requests are private by default.
42
42
Currently, this can't be changed, but we are planning to support this.
43
43
44
44
Limitations
45
45
-----------
46
46
47
- - Auto-builds for pull/merge requests have
48
- :doc: `the same limitations as regular documentation builds </builds >`.
47
+ - Builds from pull requests have the same memory and time limitations
48
+ :doc: `as regular builds </builds >`.
49
49
- Only available for GitHub and GitLab.
50
- - Additional formats like PDF and Epub aren't built to produce results quicker.
50
+ - Additional formats like PDF and Epub aren't built to produce results quicker.
51
51
- Searches will default to the default experience for your tool.
52
52
This is a feature we plan to add,
53
53
but don't want to overwhelm our search indexes used in production.
54
- - The built documentation is kept for 90 days after the pull/merge request has been closed or merged.
54
+ - The built documentation is kept for 90 days after the pull request has been closed or merged.
55
55
56
56
Troubleshooting
57
57
---------------
0 commit comments