Skip to content
This repository has been archived by the owner on Jul 3, 2024. It is now read-only.

make open doc happen error #567

Closed
sss22213 opened this issue Nov 7, 2020 · 2 comments
Closed

make open doc happen error #567

sss22213 opened this issue Nov 7, 2020 · 2 comments

Comments

@sss22213
Copy link

sss22213 commented Nov 7, 2020

when i make open doc, happen some error.

Opening /mnt/usb2/e_sdk/freedom-e-sdk/doc/html/index.html
gio: file:///mnt/usb2/e_sdk/freedom-e-sdk/doc/html/index.html: Error when getting information for file “/mnt/usb2/e_sdk/freedom-e-sdk/doc/html/index.html”: No such file or directory
make: *** [Makefile:173: open-docs] Error 4

i change directory into doc, and make. happen:

rm -rf html/* html/.buildinfo html/.doctrees
sphinx-build -b html sphinx html
Running Sphinx v1.8.5

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/sphinx/config.py", line 368, in eval_config_file
    execfile_(filename, namespace)
  File "/usr/lib/python3/dist-packages/sphinx/util/pycompat.py", line 150, in execfile_
    exec_(code, _globals)
  File "/mnt/usb2/e_sdk/freedom-e-sdk/doc/sphinx/conf.py", line 27, in <module>
    version = os.environ['RELEASE_TAG']
  File "/usr/lib/python3.8/os.py", line 675, in __getitem__
    raise KeyError(key) from None
KeyError: 'RELEASE_TAG'

make: *** [Makefile:17: html/index.html] Error 2
@megha-an
Copy link

megha-an commented Feb 9, 2021

There is a keyError for RELEASE_TAG variable

because there is no environ variable with key name RELEASE_TAG

code:

os.environ['RELEASE_TAG'] in /usr/lib/python3/dist-packages/sphinx/config.py is trying to fetch the RELEASE_TAG variable value , which is not present in os.environ

so it is throwing KeyError: 'RELEASE_TAG'

solution :

I commented these two lines and run make
it works

#version = os.environ['RELEASE_TAG']
#release = version

@sss22213
Copy link
Author

sss22213 commented Feb 10, 2021

hi megha-an,
i found

version = os.environ['RELEASE_TAG']

on freedom-e-sdk/doc/sphinx/conf.py line 27

release = version

on freedom-e-sdk/doc/sphinx/conf.py line 29

and then commit
it works, thanks.

megha-an added a commit to megha-an/freedom-e-sdk that referenced this issue Feb 18, 2021
megha-an added a commit to megha-an/freedom-e-sdk that referenced this issue Feb 18, 2021
megha-an added a commit to megha-an/freedom-e-sdk that referenced this issue Feb 18, 2021
megha-an added a commit to megha-an/freedom-e-sdk that referenced this issue Feb 22, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants