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

config directory doesn't contain a conf.py file #23

Open
pnlph opened this issue Jan 24, 2020 · 0 comments
Open

config directory doesn't contain a conf.py file #23

pnlph opened this issue Jan 24, 2020 · 0 comments

Comments

@pnlph
Copy link

pnlph commented Jan 24, 2020

Hi,

i get a 404: Not found error in the preview, as well in an external browser.

Because of #7 I made sure to open the project in a standalone Atom instance, so when testing the feature, I have only one project opened in the current instance.

This is the application error from the container logs:

+--------- manually triggered build ---------------------------------------------
Application error:
config directory doesn't contain a conf.py file (/web)
+--------------------------------------------------------------------------------
[I 200124 08:35:59 server:296] Serving on http://0.0.0.0:8000
[I 200124 08:35:59 handlers:62] Start watching changes
[I 200124 08:35:59 handlers:64] Start detecting changes
[W 200124 08:41:48 web:2162] 404 GET /doc/user-manual/index.html (172.17.0.1) 109.59ms
[W 200124 08:41:48 web:2162] 404 GET /doc/user-manual/index.html (172.17.0.1) 4.27ms
[W 200124 08:41:50 web:2162] 404 GET /doc/user-manual/index.html (172.17.0.1) 4.11ms
[W 200124 08:41:50 web:2162] 404 GET /favicon.ico (172.17.0.1) 13.25ms
[W 200124 08:41:50 web:2162] 404 GET /favicon.ico (172.17.0.1) 4.02ms

I guess the conf.py file is not being detected. In the project that i am working on, conf.py is in the root sphinx directory, not in a folder config/

A note about the tree view: the sphinx folder is not the root of the project, but placed in ROOT/doc/user-manual

The workaround that I found was opening the sphinx directory ROOT/doc/user-manual and then only warnings are thrown, like not finding the .css elements in ROOT/src/data

+--------- manually triggered build ---------------------------------------------
| Running Sphinx v1.8.5
| building [mo]: targets for 0 po files that are out of date
| building [html]: targets for 63 source files that are out of date
| updating environment: 63 added, 0 changed, 0 removed
reading sources... [100%] tools/search-aboutemammingingclared-variables
/web/tools/generating-html.rst:14: WARNING: download file not readable: /src/data/Agda.css
/web/tools/generating-latex.rst:411: WARNING: Include file u'/test/LaTeXAndHTML/succeed/Links.lagda' not found or reading it failed
| looking for now-outdated files... none found
| pickling environment... done
| checking consistency... done
| preparing documents... done
writing output... [100%] tools/search-aboutemammingingclared-variables
WARNING: convert command 'convert' cannot be run.check the image_converter setting
WARNING: convert command 'convert' cannot be run.check the image_converter setting
WARNING: LaTeX command 'latex' cannot be run (needed for math display), check the imgmath_latex setting
| generating indices... genindex
| writing additional pages... search
copying images... [100%] agda.svgg-started/../agda.svg
copying downloadable files... [100%] tools/beamer-pdflatex.lagda.texexxnt-fonts.lagda.tex
| copying static files... done
| copying extra files... done
| dumping search index in English (code: en) ... done
| dumping object inventory... done
| build succeeded, 5 warnings.
| 
| The HTML pages are in _build/html.
+--------------------------------------------------------------------------------

In this case, the HTML pages are built in ROOT/doc/user-manual/build/html and the preview is available at http://127.0.0.1:30000/doc/user-manual/index.html only when refreshing.

Is this atom package compatible with projects that do not have the documentation at root?

Thanks!

Mac OS 10.12.6
Atom 1.43.0
sphinx-preview 0.15
browser-plus 0.0.98
docker 2.2.0
Sphinx v1.8.5
External browser: Firefox 72.0.2

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