IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Improve sphinx.project docstrings

Browse Source
This commit is contained in:
Louis Maddox 2021-07-18 18:48:50 +01:00 committed by GitHub
parent d626c93677
commit 29b20ff742
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sphinx/project.py
View File

@ -22,7 +22,7 @@ EXCLUDE_PATHS = ['**/_sources', '.#*', '**/.#*', '*.lproj/**']
class Project:
"""A project is source code set of Sphinx document."""
"""A project is the source code set of the Sphinx document(s)."""
def __init__(self, srcdir: str, source_suffix: Dict[str, str]) -> None:
#: Source directory.
@ -61,7 +61,7 @@ class Project:
return self.docnames
def path2doc(self, filename: str) -> Optional[str]:
"""Return the docname for the filename if the file is document.
"""Return the docname for the filename if the file is a document.
*filename* should be absolute or relative to the source directory.
"""