Comments (8)
Yeah, I guess this doesn't make full sense that conf.py is there. But, since the source directory is the "truth" you point to. The actual content there doesn't have a way to refer to a conf.py file somewhere else (and a quick check doesn't show a way to direct from conf.py to the root, but anyway sphinx-build has to point to the source directory. Even if not ideally organized, I think we should stick to the convention.
from sphinx-lesson.
Also "only index.rst for now" is outdated.
from sphinx-lesson.
It looks to me like conf.py is in the wrong place? I don't think it should be inside "content/", right?
from sphinx-lesson.
from sphinx-lesson.
You are right. But I find this a bit surprising. Since configuration is not "content". But nothing that needs to be changed right now.
from sphinx-lesson.
Do you mind if I move conf.py
back to root folder? I find it strange to have it in "content".
from sphinx-lesson.
I don't think so, because:
- sphinx-quickstart, with separate source and build directories, puts conf.py in the sourcedir.
- Default path to find conf.py is same as sourcedir, if it's different then an extra
-c
option will always be needed, that'll make it less consistent and harder for others to get started - RTD by default looks for conf.py and uses its directory as source dir: https://docs.readthedocs.io/en/stable/faq.html#where-do-i-need-to-put-my-docs-for-rtd-to-find-it
It may not be content, but content is really "sourcedir" and the standard seems to be to put it in there. I think consistency is more useful (and in the long run less surprising). We could rename "content" to "source" to better match the output of sphinx-quickstart and make it less surprising that way?
from sphinx-lesson.
OK I thought the location of index.rst could be given in conf.py but if that is not easy, I agree we should not require special flags and better leave it where it is.
from sphinx-lesson.
Related Issues (20)
- Add .jupyter_cache/ to .gitignore
- Should this repo be a template repo? HOT 3
- Can we color boxes differently? HOT 17
- Dropdown boxes shown by default HOT 2
- Are the symbols emojis? Or something else? HOT 6
- Copy button on code blocks broken in main page HOT 13
- How to make the side menu collapsible? HOT 5
- Is it possible to make the notebooks executable? HOT 13
- Automatic counters for challenges HOT 4
- Build problems on Python 3.9.2 HOT 8
- Unknown directive type "exercise". HOT 2
- Wrong link in PyP HOT 2
- cssname method now missing HOT 2
- exerciselist directive sometimes only shows the solution HOT 8
- The exercise list doesn't work with links in the exercises HOT 1
- error locally after upgrading sphinx_lesson HOT 4
- problem rendering math HOT 3
- Prompt (e.g. `$` is copied with sphinx-copybutton) HOT 1
- should `discussion` be included in the exercise list directive? HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinx-lesson.