Doc build commands not working on Windows 10

[peterennis]

@chrissimpkins

Windows 10

(venv) C:\ae\adaept.com\ae-pyfont\fonttools>cd Doc

(venv) C:\ae\adaept.com\ae-pyfont\fonttools\Doc>make
'sphinx-build' is not recognized as an internal or external command,
operable program or batch file.

(venv) C:\ae\adaept.com\ae-pyfont\fonttools\Doc>sphinx-build -b html source build
'sphinx-build' is not recognized as an internal or external command,
operable program or batch file.

(venv) C:\ae\adaept.com\ae-pyfont\fonttools\Doc>

[peterennis]

So, from here: #1333

I find this command: pip install sphinx sphinx_rtd_theme

This result:

(venv) C:\ae\adaept.com\ae-pyfont\fonttools>pip install sphinx sphinx_rtd_theme
Collecting sphinx
  Downloading Sphinx-2.3.1-py3-none-any.whl (2.7 MB)
     |████████████████████████████████| 2.7 MB 731 kB/s
Collecting sphinx_rtd_theme
  Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB)
     |████████████████████████████████| 6.4 MB 1.5 MB/s
Collecting requests>=2.5.0
  Downloading requests-2.22.0-py2.py3-none-any.whl (57 kB)
     |████████████████████████████████| 57 kB 2.7 MB/s
Collecting sphinxcontrib-qthelp
  Downloading sphinxcontrib_qthelp-1.0.2-py2.py3-none-any.whl (90 kB)
     |████████████████████████████████| 90 kB 6.1 MB/s
Collecting sphinxcontrib-jsmath
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Collecting alabaster<0.8,>=0.7
  Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB)
Collecting packaging
  Downloading packaging-20.0-py2.py3-none-any.whl (36 kB)
Collecting babel!=2.0,>=1.3
  Downloading Babel-2.8.0-py2.py3-none-any.whl (8.6 MB)
     |████████████████████████████████| 8.6 MB 435 kB/s
Collecting docutils>=0.12
  Downloading docutils-0.16-py2.py3-none-any.whl (548 kB)
     |████████████████████████████████| 548 kB 819 kB/s
Collecting sphinxcontrib-serializinghtml
  Downloading sphinxcontrib_serializinghtml-1.1.3-py2.py3-none-any.whl (89 kB)
     |████████████████████████████████| 89 kB 2.0 MB/s
Collecting sphinxcontrib-devhelp
  Downloading sphinxcontrib_devhelp-1.0.1-py2.py3-none-any.whl (84 kB)
     |████████████████████████████████| 84 kB 2.0 MB/s
Collecting sphinxcontrib-htmlhelp
  Downloading sphinxcontrib_htmlhelp-1.0.2-py2.py3-none-any.whl (96 kB)
     |████████████████████████████████| 96 kB 2.2 MB/s
Requirement already satisfied: setuptools in c:\ae\adaept.com\ae-pyfont\fonttools\venv\lib\site-packages (from sphinx) (41.2.0)
Collecting colorama>=0.3.5; sys_platform == "win32"
  Downloading colorama-0.4.3-py2.py3-none-any.whl (15 kB)
Collecting Pygments>=2.0
  Downloading Pygments-2.5.2-py2.py3-none-any.whl (896 kB)
     |████████████████████████████████| 896 kB 1.1 MB/s
Collecting Jinja2>=2.3
  Downloading Jinja2-2.10.3-py2.py3-none-any.whl (125 kB)
     |████████████████████████████████| 125 kB 2.2 MB/s
Collecting imagesize
  Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB)
Collecting sphinxcontrib-applehelp
  Downloading sphinxcontrib_applehelp-1.0.1-py2.py3-none-any.whl (121 kB)
     |████████████████████████████████| 121 kB 2.2 MB/s
Collecting snowballstemmer>=1.1
  Downloading snowballstemmer-2.0.0-py2.py3-none-any.whl (97 kB)
     |████████████████████████████████| 97 kB 1.3 MB/s
Collecting chardet<3.1.0,>=3.0.2
  Downloading chardet-3.0.4-py2.py3-none-any.whl (133 kB)
     |████████████████████████████████| 133 kB 2.2 MB/s
Collecting idna<2.9,>=2.5
  Downloading idna-2.8-py2.py3-none-any.whl (58 kB)
     |████████████████████████████████| 58 kB 2.8 MB/s
Collecting urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1
  Downloading urllib3-1.25.8-py2.py3-none-any.whl (125 kB)
     |████████████████████████████████| 125 kB 2.2 MB/s
Collecting certifi>=2017.4.17
  Downloading certifi-2019.11.28-py2.py3-none-any.whl (156 kB)
     |████████████████████████████████| 156 kB 2.2 MB/s
Collecting six
  Downloading six-1.14.0-py2.py3-none-any.whl (10 kB)
Collecting pyparsing>=2.0.2
  Downloading pyparsing-2.4.6-py2.py3-none-any.whl (67 kB)
     |████████████████████████████████| 67 kB 936 kB/s
Collecting pytz>=2015.7
  Using cached pytz-2019.3-py2.py3-none-any.whl (509 kB)
Collecting MarkupSafe>=0.23
  Downloading MarkupSafe-1.1.1.tar.gz (19 kB)
Installing collected packages: chardet, idna, urllib3, certifi, requests, sphinxcontrib-qthelp, sphinxcontrib-jsmath, alabaster, six, pyparsing, packaging, pytz, babel, docutils, sphinxcontrib-serializinghtml, sphinxcontrib-devhelp, sphinxcontrib-htmlhelp, colorama, Pygments, MarkupSafe, Jinja2, imagesize, sphinxcontrib-applehelp, snowballstemmer, sphinx, sphinx-rtd-theme
    Running setup.py install for MarkupSafe ... done
Successfully installed Jinja2-2.10.3 MarkupSafe-1.1.1 Pygments-2.5.2 alabaster-0.7.12 babel-2.8.0 certifi-2019.11.28 chardet-3.0.4 colorama-0.4.3 docutils-0.16 idna-2.8 imagesize-1.2.0 packaging-20.0 pyparsing-2.4.6 pytz-2019.3 requests-2.22.0 six-1.14.0 snowballstemmer-2.0.0 sphinx-2.3.1 sphinx-rtd-theme-0.4.3 sphinxcontrib-applehelp-1.0.1 sphinxcontrib-devhelp-1.0.1 sphinxcontrib-htmlhelp-1.0.2 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.2 sphinxcontrib-serializinghtml-1.1.3 urllib3-1.25.8

(venv) C:\ae\adaept.com\ae-pyfont\fonttools>

[peterennis]

Try the build again:

(venv) C:\ae\adaept.com\ae-pyfont\fonttools>sphinx-build -b html source build

Application error:
config directory doesn't contain a conf.py file (source)

(venv) C:\ae\adaept.com\ae-pyfont\fonttools>

[chrissimpkins]

Sorry for the troubles. Can you show me the contents of the fonttools/Docs/source directory and let me know what branch you are building?

This conf.py file should be included there.

[peterennis]

File structure looks like this:

Conf.py

conf.py.zip

Branch

[chrissimpkins]

I can verify that the following series of commands build the RTD docs for me on macOS 10.15.1. This uses the readthedocs branch @ 7d85612

$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install --upgrade pip
$ pip install -e ".[all]"
$ pip install sphinx sphinx_rtd_theme
$ cd Doc
$ sphinx-build -b html source build

I think that the missing step is to make the Doc directory your working directory before you run the sphinx-build command. If I try to execute the command from the repository root, I get the same error message:

Application error:
config directory doesn't contain a conf.py file (source)

It appears that sphinx-build doesn't walk the directory tree. You need to build from the directory that includes the configuration file.

Here is the full static site build so that you have it while you work through the build issues.

build.zip

Let me know if the above approach does not work for you. Fingers crossed...

[peterennis]

The build.zip works. Now I have some reading to do 😄

I will test out your build steps.

[belluzj]

Hello! I managed to build the documentation perfectly fine on Windows 10 just now.

@peterennis I think what went wrong is that in your comment #1806 (comment) you should run the sphinx-build -b html source build command from inside the Doc/ folder

[behdad]

Anything actionable here?