Skip to content

Commit

Permalink
Address ReadTheDocs build error (since Aug 2023)
Browse files Browse the repository at this point in the history
  • Loading branch information
rayluo committed Jan 12, 2024
1 parent b03f34a commit bb91a8d
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
12 changes: 12 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.12"
python:
install:
- requirements: docs/requirements.txt
sphinx:
configuration: docs/conf.py
builder: html
fail_on_warning: true
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en" # The old value None will fallback to "en" with a warning

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down Expand Up @@ -95,7 +95,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = [] # ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down
4 changes: 4 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,20 @@ Identity Documentation
======================

.. The following summary is reused in, and needs to be in-sync with, the ../README.md
This Identity library is an authentication/authorization library that:

* Suitable for apps that are targeting end users on
`Microsoft identity platform <https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-overview>`_.
(which includes Work or school accounts provisioned through Azure AD,
and Personal Microsoft accounts such as Skype, Xbox, Outlook.com).

* Currently designed for web apps,
regardless of which Python web framework you are using.

* Provides a set of high level API that is built on top of, and easier to be used than
`Microsoft's MSAL Python library <https://github.com/AzureAD/microsoft-authentication-library-for-python>`_.

* Written in Python, for Python apps.

.. toctree::
Expand Down

0 comments on commit bb91a8d

Please sign in to comment.