Skip to content

[int] Docs: RTD: fix path to DIRAC source code #4862

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

Merged
atsareg merged 1 commit into from
Dec 9, 2020
Merged

[int] Docs: RTD: fix path to DIRAC source code #4862

Show file tree
Hide file tree
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
9 changes: 5 additions & 4 deletions docs/diracdoctools/Utilities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,30 +69,31 @@ def writeLinesToFile(filename, lines):
LOG.debug('Not updating file content for %s', os.path.join(os.getcwd(), filename))


def setUpReadTheDocsEnvironment(moduleName='DIRAC'):
def setUpReadTheDocsEnvironment(moduleName='DIRAC', location='../../'):
"""Create the necessary links and environment variables to create documentation inside readthedocs.

Ensure that ``moduleName`` is in the PYTHONPATH by creating a link pointing to the basefolder of the source code.

:param str moduleName: name of the base source code module, default 'DIRAC'
:param str location: Path to the location where the module can be found relative to the 'conf.py'. Default '../../'
"""
LOG.info('Running for READTHEDOCS')
sys.path.append(os.path.abspath('.'))
diracPath = os.path.abspath(os.path.join(os.getcwd(), '../src'))
diracPath = os.path.abspath(os.path.join(os.getcwd(), location))
LOG.info('Path To Module(?): %r', diracPath)

buildfolder = '_build'
mkdir(os.path.abspath('../' + buildfolder))

# We need to have the moduleName somewhere, or we cannot import it, as
# readtheDocs clones the repo into something based on the branchname
if not os.path.exists(os.path.join('../src', moduleName)):
if not os.path.exists(os.path.join(location, moduleName)):
diracLink = os.path.abspath(os.path.join(os.getcwd(), '../', buildfolder, moduleName))
LOG.info('Link: %r', diracLink)
if not os.path.exists(diracLink):
LOG.info('Creating symbolic link %r -> %r', diracPath, diracLink)
os.symlink(diracPath, diracLink)
diracPath = os.path.abspath(os.path.join(diracLink, 'src'))
diracPath = os.path.abspath(os.path.join(diracLink, '..'))

sys.path.insert(0, diracPath)

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

# AUTO SETUP START
if os.environ.get('READTHEDOCS') == 'True':
setUpReadTheDocsEnvironment(moduleName='DIRAC')
setUpReadTheDocsEnvironment(moduleName='DIRAC', location='../../src')

# re-create the RST files for the command references
LOG.info('Building command reference')
Expand Down