Skip to content

Commit c5b136f

Browse files
authored
Docs: Adding a pattern for reusing "Only on Read the Docs for Business" admonition (Diátaxis refactor) (#9754)
* Adding a pattern for reusing "Only on Read the Docs for Business" admonition * Exclude shared files from TOC and build * Remove second occurrence of exclude_patterns in conf.py 🤕
1 parent 40f253d commit c5b136f

File tree

6 files changed

+12
-22
lines changed

6 files changed

+12
-22
lines changed

docs/conf.py

+1-5
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
copyright = "Read the Docs, Inc & contributors"
7272
version = "8.9.0"
7373
release = version
74-
exclude_patterns = ["_build"]
74+
exclude_patterns = ["_build", "shared"]
7575
default_role = "obj"
7676
intersphinx_mapping = {
7777
"python": ("https://docs.python.org/3.10/", None),
@@ -131,10 +131,6 @@
131131
)
132132
]
133133

134-
exclude_patterns = [
135-
# 'api' # needed for ``make gettext`` to not die.
136-
]
137-
138134
language = "en"
139135

140136
locale_dirs = [

docs/user/commercial/organizations.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
Organizations
22
-------------
33

4-
.. note::
5-
This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`_.
4+
.. include:: /shared/admonition-rtd-business.rst
65

76
Organizations allow you to segment who has access to what projects in your company.
87
Your company will be represented as an Organization,

docs/user/commercial/privacy-level.rst

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
Project Privacy Level
22
---------------------
33

4-
.. note::
5-
6-
This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`__.
4+
.. include:: /shared/admonition-rtd-business.rst
75

86
By default, only users that belong to your organization can see the dashboard of your project and its builds.
97
If you want users outside your organization and anonymous users to be able to see the dashboard of your project,

docs/user/commercial/sharing.rst

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
Sharing
22
=======
33

4-
.. note::
5-
6-
This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`__.
4+
.. include:: /shared/admonition-rtd-business.rst
75

86
You can share your project with users outside of your company:
97

@@ -34,7 +32,7 @@ Enabling Sharing
3432
* Give that information to the person who you want to give access.
3533

3634
.. note::
37-
35+
3836
You can always revoke access in the same panel.
3937

4038
Users can log out by using the :ref:`Log Out <versions:Logging out>` link in the RTD flyout menu.
@@ -85,7 +83,7 @@ The header has the form ``Authorization: Token <ACCESS_TOKEN>``.
8583
For example:
8684

8785
.. prompt:: bash $
88-
86+
8987
curl -H "Authorization: Token 19okmz5k0i6yk17jp70jlnv91v" https://docs.example.com/en/latest/example.html
9088

9189
Basic Authorization
@@ -95,5 +93,5 @@ You can also use basic authorization, with the token as user and an empty passwo
9593
For example:
9694

9795
.. prompt:: bash $
98-
96+
9997
curl --url https://docs.example.com/en/latest/example.html --user '19okmz5k0i6yk17jp70jlnv91v:'

docs/user/commercial/single-sign-on.rst

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
Single Sign-On
22
==============
33

4-
.. note::
5-
6-
This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`__.
7-
4+
.. include:: /shared/admonition-rtd-business.rst
85

96
Single sign-on is supported on |com_brand| for all users.
107
:abbr:`SSO (single sign-on)` will allow you to grant permissions to your organization's projects in an easy way.
@@ -34,10 +31,10 @@ your organization's detail page > :guilabel:`Settings` > :guilabel:`Authorizatio
3431
and selecting :guilabel:`GitHub, GitLab or Bitbucket` as provider.
3532

3633
Note the users created under Read the Docs must have their GitHub, Bitbucket or GitLab
37-
:doc:`account connected </connected-accounts>` in order to make SSO work.
34+
:doc:`account connected </connected-accounts>` in order to make SSO work.
3835
You can read more about `granting permissions on GitHub`_.
3936

40-
.. warning:: Once you enable this option, your existing Read the Docs teams will not be used.
37+
.. warning:: Once you enable this option, your existing Read the Docs teams will not be used.
4138

4239
.. _granting permissions on GitHub: https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization
4340

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. note::
2+
This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`_.

0 commit comments

Comments
 (0)