From b892c00ac6b650d262af6d8754ebbf1828c77b8d Mon Sep 17 00:00:00 2001 From: Iain Learmonth Date: Wed, 27 Apr 2022 14:50:41 +0100 Subject: [PATCH] docs: update for sphinx-jsonschema 1.19.0 --- app/lists/bc2.py | 5 +++++ app/lists/bridgelines.py | 7 ++++++- app/lists/mirror_mapping.py | 5 +++++ docs/conf.py | 2 ++ docs/tech/schemas.rst | 6 +++--- 5 files changed, 21 insertions(+), 4 deletions(-) diff --git a/app/lists/bc2.py b/app/lists/bc2.py index 118c695..933e840 100644 --- a/app/lists/bc2.py +++ b/app/lists/bc2.py @@ -1,3 +1,4 @@ +import builtins from datetime import datetime from typing import List @@ -58,3 +59,7 @@ def mirror_sites(): ]} for x in Origin.query.order_by(Origin.domain_name).all() if x.destroyed is None ] } + + +if getattr(builtins, "__sphinx_build__", False): + schema = BypassCensorship2.schema_json() diff --git a/app/lists/bridgelines.py b/app/lists/bridgelines.py index 6e83d76..825bb1e 100644 --- a/app/lists/bridgelines.py +++ b/app/lists/bridgelines.py @@ -1,3 +1,4 @@ +import builtins from typing import List from pydantic import BaseModel, Field @@ -11,7 +12,7 @@ class Bridgelines(BaseModel): ) bridgelines: List[str] = Field( description="List of bridgelines, ready for use in a torrc file", - examples = [ + examples=[ "obfs4 71.73.124.31:8887 E81B1237F6D13497B166060F55861565593CFF8E cert=b54NsV6tK1g+LHaThPOTCibdpx3wHm9NFe0PzGF1nwz+4M/tq6SkfOaShzPnZsIRCFRIHg iat-mode=0", "obfs4 172.105.176.101:80 D18BC7E082D7EBF8E851029AC89A12A3F44A50BF cert=KHfAAUptXWRmLy3ehS9ETMO5luY06d0w7tEBDiAI0z62nC5Qo/APrzZxodkYWX2bNko/Mw iat-mode=0", "obfs4 141.101.36.55:9023 045EF272F08BC11CDB985889E4E9FE35DC6F9C67 cert=6KEdf/5aDSyuYEqvo14JE8Cks3i7PQtj9EFX2wTCiEaUPsp/I7eaOm4uSWdqwvV4vTVlFw iat-mode=0" @@ -32,3 +33,7 @@ def bridgelines(): ) ] ).dict() + + +if getattr(builtins, "__sphinx_build__", False): + schema = Bridgelines.schema_json() diff --git a/app/lists/mirror_mapping.py b/app/lists/mirror_mapping.py index dd7cbd9..c0d3a17 100644 --- a/app/lists/mirror_mapping.py +++ b/app/lists/mirror_mapping.py @@ -1,3 +1,4 @@ +import builtins from typing import Dict from pydantic import BaseModel, Field @@ -29,3 +30,7 @@ def mirror_mapping(): origin_domain_root=extract(d.origin.domain_name).registered_domain ) for d in Proxy.query.all() if d.url is not None }).dict() + + +if getattr(builtins, "__sphinx_build__", False): + schema = MirrorMapping.schema_json() diff --git a/docs/conf.py b/docs/conf.py index 100fe0d..4bd725c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,7 +1,9 @@ +import builtins import os import sys sys.path.insert(0, os.path.abspath('..')) +builtins.__sphinx_build__ = True # -- Project information ----------------------------------------------------- diff --git a/docs/tech/schemas.rst b/docs/tech/schemas.rst index 38824e6..a027725 100644 --- a/docs/tech/schemas.rst +++ b/docs/tech/schemas.rst @@ -4,14 +4,14 @@ Mirror List Formats Bypass Censorship Extension --------------------------- -.. jsonschema:: ../../schemas/bc2.json +.. jsonschema:: app.lists.bc2.schema Mirror Analytics ---------------- -.. jsonschema:: ../../schemas/mirror-mapping.json +.. jsonschema:: app.lists.mirror_mapping.schema Tor Bridges ----------- -.. jsonschema:: ../../schemas/bridgelines.json \ No newline at end of file +.. jsonschema:: app.lists.bridgelines.schema \ No newline at end of file