Skip to content
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.

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

Error in generating sphinx #1

Open
mianasbat opened this issue Dec 15, 2020 · 0 comments
Open

Error in generating sphinx #1

mianasbat opened this issue Dec 15, 2020 · 0 comments

Comments

@mianasbat
Copy link

Hi,
Thanks for the helpful youtube video.
I tried the tutorial but I got an error in generating output.
I think the sphinx-quickstart also changed the script a bit.
I got the following output

(env1) ➜  docs git:(master) ✗ ls
Makefile   _build     _static    _templates conf.py    index.rst  make.bat
(env1) ➜  docs git:(master) ✗ sphinx-apidoc -o . ..        
Creating file ./spamfilter.rst.
Creating file ./test_spamfilter.rst.
Creating file ./token.rst.
Creating file ./modules.rst.
(env1) ➜  docs git:(master) ✗ make clean html
Removing everything under '_build'...
Running Sphinx v3.3.1
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 5 source files that are out of date
updating environment: [new config] 5 added, 0 changed, 0 removed
reading sources... [100%] token                                                                                           
/Users/mianasbatahmad/spamfilter-py/docs/spamfilter.rst:4: WARNING: Unknown directive type "automodule".

.. automodule:: spamfilter
   :members:
   :undoc-members:
   :show-inheritance:
/Users/mianasbatahmad/spamfilter-py/docs/test_spamfilter.rst:4: WARNING: Unknown directive type "automodule".

.. automodule:: test_spamfilter
   :members:
   :undoc-members:
   :show-inheritance:
/Users/mianasbatahmad/spamfilter-py/docs/token.rst:4: WARNING: Unknown directive type "automodule".

.. automodule:: token
   :members:
   :undoc-members:
   :show-inheritance:
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] token                                                                                            
generating indices... genindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 3 warnings.

The HTML pages are in _build/html.

Here is my sphinx version etc.

(env1) ➜  docs git:(master) ✗ pip list 
Package                       Version
----------------------------- ---------
alabaster                     0.7.12
autopep8                      1.5.4
Babel                         2.9.0
certifi                       2020.12.5
chardet                       3.0.4
commonmark                    0.9.1
docutils                      0.16
idna                          2.10
imagesize                     1.2.0
Jinja2                        2.11.2
MarkupSafe                    1.1.1
packaging                     20.8
pip                           20.3.1
pycodestyle                   2.6.0
Pygments                      2.7.3
pyparsing                     2.4.7
pytz                          2020.4
recommonmark                  0.6.0
requests                      2.25.0
setuptools                    51.0.0
snowballstemmer               2.0.0
Sphinx                        3.3.1
sphinx-rtd-theme              0.5.0
sphinxcontrib-applehelp       1.0.2
sphinxcontrib-devhelp         1.0.2
sphinxcontrib-htmlhelp        1.0.3
sphinxcontrib-jsmath          1.0.1
sphinxcontrib-qthelp          1.0.3
sphinxcontrib-serializinghtml 1.1.4
toml                          0.10.2
urllib3                       1.26.2
wheel                         0.36.2

Any idea why am I getting the error.
Can you try generating the docs using your repo and see if this version of sphinx still works for you.
Many thanks
Mian

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant