mirror of
https://github.com/zulip/zulip.git
synced 2025-11-05 14:35:27 +00:00
api-docs: Move markdown files to top level directory.
- Updates `.prettierignore` for the new directory.
- Updates any reference to the API documentation directory for
markdown files to be `api_docs/` instead of `zerver/api/`.
- Removes a reference link from `docs/documentation/api.md` that
hasn't referenced anything in the text since commit 0542c60.
- Update rendering of API documentation for new directory.
This commit is contained in:
committed by
Tim Abbott
parent
fc54ffd778
commit
dbacc00f0f
@@ -38,9 +38,7 @@ def test_generated_curl_examples_for_success(client: Client) -> None:
|
||||
# on "add" tests coming before "remove" tests in some cases. We
|
||||
# should try to either avoid ordering dependencies or make them
|
||||
# very explicit.
|
||||
rest_endpoints_path = os.path.join(
|
||||
settings.DEPLOY_ROOT, "templates/zerver/api/include/rest-endpoints.md"
|
||||
)
|
||||
rest_endpoints_path = os.path.join(settings.DEPLOY_ROOT, "api_docs/include/rest-endpoints.md")
|
||||
with open(rest_endpoints_path) as f:
|
||||
rest_endpoints_raw = f.read()
|
||||
ENDPOINT_REGEXP = re.compile(r"/api/\s*(.*?)\)")
|
||||
@@ -48,7 +46,7 @@ def test_generated_curl_examples_for_success(client: Client) -> None:
|
||||
|
||||
for endpoint in endpoint_list:
|
||||
article_name = endpoint + ".md"
|
||||
file_name = os.path.join(settings.DEPLOY_ROOT, "templates/zerver/api/", article_name)
|
||||
file_name = os.path.join(settings.DEPLOY_ROOT, "api_docs/", article_name)
|
||||
curl_commands_to_test = []
|
||||
|
||||
if os.path.exists(file_name):
|
||||
|
||||
Reference in New Issue
Block a user