upstream/ipython Files · tools/fixup_whats_new_pr.py

Fix unintentional skipping of module level doctests...

Fix unintentional skipping of module level doctests Importing `skip_doctest` decorator unintentionally marks for skipping a module level doctest. It happens because doctests discovery only checks whether a variable with name `skip_doctest` is presented without checking the type. I have renamed the 'magic' variable name to `__skip_doctest__` to resolve the name clash, and also made the check actually depend on the variable content. The module level doctest in `core/debugger.py` was previously unintentionally skipped and now is disabled because it contains syntax/name errors.

rushabh-v - - Load All Authors

File last commit:

r26016:50a8bd8a


                r26873:17153999

Download file

             fixup_whats_new_pr.py
        
                    39 lines
            
             | 1.1 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / tools / fixup_whats_new_pr.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """

      This tool is used during CI testing to make sure sphinx raise no error.

      During development, we like to have whatsnew/pr/*.rst documents to track

      individual new features. Unfortunately they other either:

        - have no title (sphinx complains)

        - are not included in any toctree (sphinx complain)

      This fix-them up by "inventing" a title, before building the docs. At release

      time, these title and files will anyway be rewritten into the actual release

      notes.

      """

      from pathlib import Path

      def main():

          folder = Path("docs/source/whatsnew/pr/")

          files = list(folder.glob("*.rst"))

          print(files)

          for filepath in files:

              print("Adding pseudo-title to:", filepath.name)

              title = filepath.name[:-4].split("/")[-1].replace("-", " ").capitalize()

              data = filepath.read_text()

              try:

                  if data and data.splitlines()[1].startswith('='):

                      continue

              except IndexError:

                  pass

              with filepath.open("w") as f:

                  f.write(title + "\n")

                  f.write("=" * len(title) + "\n\n")

                  f.write(data)

      if __name__ == '__main__':

          main()

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				"""
				This tool is used during CI testing to make sure sphinx raise no error.

				During development, we like to have whatsnew/pr/*.rst documents to track
				individual new features. Unfortunately they other either:
				- have no title (sphinx complains)
				- are not included in any toctree (sphinx complain)

				This fix-them up by "inventing" a title, before building the docs. At release
				time, these title and files will anyway be rewritten into the actual release
				notes.
				"""

				from pathlib import Path

				def main():
				folder = Path("docs/source/whatsnew/pr/")
				files = list(folder.glob("*.rst"))
				print(files)

				for filepath in files:
				print("Adding pseudo-title to:", filepath.name)
				title = filepath.name[:-4].split("/")[-1].replace("-", " ").capitalize()

				data = filepath.read_text()
				try:
				if data and data.splitlines()[1].startswith('='):
				continue
				except IndexError:
				pass

				with filepath.open("w") as f:
				f.write(title + "\n")
				f.write("=" * len(title) + "\n\n")
				f.write(data)

				if __name__ == '__main__':
				main()