How to set a BASE URL for sphinx documentation?

Question

I have created documentation for my project using sphinx. the current endpoint for my documentation is /. My question is, how can i make my documentation follow a docs/<filename> pattern?

EX. <app.url>/docs/index.html

in my project's config.py i have:

DOCS_DIRECTORY = '/docs/'

score 0 · Answer 1 · answered Aug 30 '21 at 12:29

0

Add this line in conf.py：

html_baseurl = '/docs/'

ref: sphinx doc

answered Aug 30 '21 at 12:29

Yue JIN

1,047
1
10
20

score -1 · Answer 2 · answered Sep 11 '18 at 10:30

-1

you should call sphinx-build -b html sourcedir builddir. See the Sphinx doc, page First Steps with Sphinx

answered Sep 11 '18 at 10:30

Humbalan

677
3
14

when my documentation is built i see it live at http://127.0.0.1:8000/index.html . what i want to see is http://127.0.0.1:8000/docs/index.html @humbalan – juan_code18 Sep 11 '18 at 17:28
what did you input as builddir? – Humbalan Sep 12 '18 at 06:57

How to set a BASE URL for sphinx documentation?

2 Answers2