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

environment: clarify docstring

Browse Source
This commit is contained in:
Georg Brandl 2013-03-30 12:33:31 +01:00
parent 1f79ba7e74
commit 2f03bb5f12
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
sphinx/environment.py
View File

@ -309,8 +309,9 @@ class BuildEnvironment:
"""Return paths to a file referenced from a document, relative to
documentation root and absolute.
Absolute filenames are relative to the source dir, while relative
filenames are relative to the dir of the containing document.
In the input "filename", absolute filenames are taken as relative to the
source dir, while relative filenames are relative to the dir of the
containing document.
"""
if filename.startswith('/') or filename.startswith(os.sep):
rel_fn = filename[1:]