Struggling with setting up the custom theme dev environment using furo as the base theme

[kapooramit]

Hi,

Can anyone guide me how to setup environment for creating a new theme using furo as the base theme. I don't want to and need to use github. I need to setup local environment. I have tried the contributing to theme guide but I get errors and localhost:8000 doesn't show anything on launching sphinx-autobuilder. I wish there was a step by step instruction for non-programmers like me...

@pradyunsg - can you help?

[pradyunsg]

Hiya! Can you paste the error that you're seeing? I cant really help as long as it is unclear what issue you might be hitting.

[kapooramit]

I will do today, For now, I have read enough but still researching more to before I can pinpoint what's going wrong. I should be able to share my findings with you today/tomorrow. If possible, please respond to my email about licensing.

Thank you!

[kapooramit]

The first error I am getting is when trying to create the package {python -m build). So as a result, I am not getting the wheel file.

python -m build
* Creating virtualenv isolated environment...
* Installing packages in isolated environment... (sphinx-theme-builder >= 0.2.0a10)
* Getting dependencies for sdist...
* Building sdist...
* Building wheel from sdist
* Creating virtualenv isolated environment...
* Installing packages in isolated environment... (sphinx-theme-builder >= 0.2.0a10)
* Getting dependencies for wheel...
* Building wheel...
[stb] # nodeenv does not exist.
[stb] # Generating new nodeenv with NodeJS 16.13.0!
[stb] # Could not find a `node` executable.
[stb] $ python -m nodeenv --node=16.13.0 C:\Users\<username>\AppData\Local\Temp\build-via-sdist-f06k0foq\furo-2021.11.23.dev1\.nodeenv
 * Install prebuilt node (16.13.0) ..... done.
symbolic link created for C:\Users\<username>\AppData\Local\Temp\build-via-sdist-f06k0foq\furo-2021.11.23.dev1\.nodeenv\Scripts\nodejs.exe <<===>> node.exe
[stb] (nodeenv) $ node --version
error: nodeenv-unhealthy-file-not-found

× The `nodeenv` for this project is unhealthy.
╰─> None

hint: Deleting the .nodeenv directory and trying again may work.

Link: https://sphinx-theme-builder.rtfd.io/errors/#nodeenv-unhealthy-file-not-found

ERROR Backend subproccess exited when trying to invoke build_wheel

[kapooramit]

Second error now. When I try to install the archive generated from above, I get the following error - fails to install.

python -m pip install .\furo-2021.11.23.dev1.tar.gz
Processing d:\furo\dist\furo-2021.11.23.dev1.tar.gz
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Requirement already satisfied: sphinx~=4.0 in c:\python310\lib\site-packages (from furo==2021.11.23.dev1) (4.3.1)
Collecting beautifulsoup4
  Using cached beautifulsoup4-4.10.0-py3-none-any.whl (97 kB)
Requirement already satisfied: pygments~=2.7 in c:\python310\lib\site-packages (from furo==2021.11.23.dev1) (2.10.0)
Requirement already satisfied: sphinxcontrib-jsmath in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (1.0.1)
Requirement already satisfied: babel>=1.3 in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (2.9.1)
Requirement already satisfied: requests>=2.5.0 in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (2.26.0)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (1.1.5)
Requirement already satisfied: sphinxcontrib-qthelp in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (1.0.3)
Requirement already satisfied: Jinja2>=2.3 in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (3.0.3)
Requirement already satisfied: imagesize in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (1.3.0)
Requirement already satisfied: alabaster<0.8,>=0.7 in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (0.7.12)
Requirement already satisfied: snowballstemmer>=1.1 in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (2.2.0)
Requirement already satisfied: colorama>=0.3.5 in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (0.4.4)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (2.0.0)
Requirement already satisfied: packaging in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (21.3)
Requirement already satisfied: docutils<0.18,>=0.14 in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (0.17.1)
Requirement already satisfied: sphinxcontrib-applehelp in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (1.0.2)
Requirement already satisfied: sphinxcontrib-devhelp in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (1.0.2)
Requirement already satisfied: setuptools in c:\python310\lib\site-packages (from sphinx~=4.0->furo==2021.11.23.dev1) (59.5.0)
Collecting soupsieve>1.2
  Using cached soupsieve-2.3.1-py3-none-any.whl (37 kB)
Requirement already satisfied: pytz>=2015.7 in c:\python310\lib\site-packages (from babel>=1.3->sphinx~=4.0->furo==2021.11.23.dev1) (2021.3)
Requirement already satisfied: MarkupSafe>=2.0 in c:\python310\lib\site-packages (from Jinja2>=2.3->sphinx~=4.0->furo==2021.11.23.dev1) (2.0.1)
Requirement already satisfied: urllib3<1.27,>=1.21.1 in c:\python310\lib\site-packages (from requests>=2.5.0->sphinx~=4.0->furo==2021.11.23.dev1) (1.26.7)
Requirement already satisfied: charset-normalizer~=2.0.0 in c:\python310\lib\site-packages (from requests>=2.5.0->sphinx~=4.0->furo==2021.11.23.dev1) (2.0.9)
Requirement already satisfied: certifi>=2017.4.17 in c:\python310\lib\site-packages (from requests>=2.5.0->sphinx~=4.0->furo==2021.11.23.dev1) (2021.10.8)
Requirement already satisfied: idna<4,>=2.5 in c:\python310\lib\site-packages (from requests>=2.5.0->sphinx~=4.0->furo==2021.11.23.dev1) (3.3)
Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in c:\python310\lib\site-packages (from packaging->sphinx~=4.0->furo==2021.11.23.dev1) (3.0.6)
Building wheels for collected packages: furo
 Building wheel for furo (pyproject.toml) ... error
  ERROR: Command errored out with exit status 1:
   command: 'C:\Python310\python.exe' 'C:\Python310\lib\site-packages\pip\_vendor\pep517\in_process\_in_process.py' build_wheel 'C:\Users\<username>\AppData\Local\Temp\tmp01ielaoe'
       cwd: C:\Users\<username>\AppData\Local\Temp\pip-req-build-ixqn0_m_
  Complete output (16 lines):
  [stb] # nodeenv does not exist.
  [stb] # Generating new nodeenv with NodeJS 16.13.0!
  [stb] # Could not find a `node` executable.
  [stb] $ python -m nodeenv --node=16.13.0
  C:\Users\a<username>\AppData\Local\Temp\pip-req-build-ixqn0_m_\.nodeenv
   * Install prebuilt node (16.13.0) ..... done.
  symbolic link created for C:\Users\<username>\AppData\Local\Temp\pip-req-build-ixqn0_m_\.nodeenv\Scripts\nodejs.exe <<===>> node.exe
  [stb] (nodeenv) $ node --version
  error: nodeenv-unhealthy-file-not-found
  x The `nodeenv` for this project is unhealthy.

  None

  hint: Deleting the .nodeenv directory and trying again may work.

  Link: https://sphinx-theme-builder.rtfd.io/errors/#nodeenv-unhealthy-file-not-found
  ----------------------------------------
  ERROR: Failed building wheel for furo
Failed to build furo
ERROR: Could not build wheels for furo, which is required to install pyproject.toml-based projects