Skip to content

Commit ad9f6e9

Browse files
committed
Add placeholder for client resolution docs.
1 parent 9fc2353 commit ad9f6e9

File tree

3 files changed

+19
-1
lines changed

3 files changed

+19
-1
lines changed

docs/source/contributors_guide/contributing.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ Documentation is built using Sphinx. To build the documentation, run the
4141
You should inspect the changes in the documentation by opening the
4242
``docs/build/html/index.html`` file in your browser.
4343

44+
.. note::
45+
If you are having trouble with the documentation and are seeing unexpected
46+
output, delete the ``docs/build`` directory and rerun the ``make html`` command.
47+
4448
You'll see a different output since the documentation is build with
4549
`sphinx-multiversion <https://github.com/sphinx-contrib/multiversion>`_ extension.
4650

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Client Resolution
2+
=================
3+
4+
TODO: Describe the approach to client resolution. See `_get_implicit_client`.

docs/source/index.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,21 @@ Every contribution, big or small, is valuable!
6363
api/submission
6464
api/types
6565

66+
67+
.. toctree::
68+
:caption: In Depth
69+
:glob:
70+
:titlesonly:
71+
:hidden:
72+
73+
in_depth/client_resolution
74+
75+
6676
.. toctree::
6777
:caption: Getting Involved
6878
:glob:
6979
:titlesonly:
7080
:hidden:
7181

7282
contributors_guide/contributing
73-
contributors_guide/release_notes
83+
contributors_guide/release_notes

0 commit comments

Comments
 (0)