Skip to content

Toggle the real RAW_ANCHOR setting in doc tests #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
njzjz-bot wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Toggle the real RAW_ANCHOR setting in doc tests #158

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions tests/test_docgen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import unittest
from typing import List

import dargs
import dargs.dargs as dargs_module
from dargs import Argument, ArgumentEncoder, Variant


Expand Down Expand Up @@ -250,17 +250,18 @@ def test_multi_variants(self) -> None:
def test_dpmd(self) -> None:
from .dpmdargs import gen_doc

dargs.RAW_ANCHOR = False
docstr = gen_doc(make_anchor=True, make_link=True)
# print("\n\n"+docstr)
# with open("out.rst", "w") as of:
# print(docstr, file=of)
# now testing raw anchor
dargs.RAW_ANCHOR = True
docstr = gen_doc(make_anchor=True, make_link=True)
# print("\n\n"+docstr)
# with open("outr.rst", "w") as of:
# print(docstr, file=of)
original_raw_anchor = dargs_module.RAW_ANCHOR
try:
dargs_module.RAW_ANCHOR = False
rst_doc = gen_doc(make_anchor=True, make_link=True)
self.assertNotIn(".. raw:: html", rst_doc)

dargs_module.RAW_ANCHOR = True
raw_doc = gen_doc(make_anchor=True, make_link=True)
self.assertIn(".. raw:: html", raw_doc)
finally:
# Avoid leaking module-level configuration into later tests.
dargs_module.RAW_ANCHOR = original_raw_anchor


if __name__ == "__main__":
Expand Down
Loading