I'm experimenting with building docs. I haven't do...
# questions
j
I'm experimenting with building docs. I haven't done this in Kedro before, and I don't have any experience in web development. After I build the docs and open the resulting html file in the browser, I would have expected the content to fill the browser window, rather than occupy only a certain width. Is this the case for everyone, or have I done something wrong? If this is the default behaviour, can it be changed?
j
hi Jordan! are you able to share a screenshot of how the docs look like? regardless, assuming you're using the default template, it uses the Sphinx documentation processor with a theme called `sphinx_rtd_theme`: https://github.com/kedro-org/kedro/blob/7f447330fc4e933ae4f5f364bb38032600b78d85/k[…]ct/%7B%7B%20cookiecutter.repo_name%20%7D%7D/docs/source/conf.py you can customise this, for example by using a more modern theme called `furo`: https://pradyunsg.me/furo/quickstart/ (you have to change the
conf.py
and also
pip install furo
) let me know how it went!
j
Thanks for the response. This is how things look at the moment:
I'm using Poetry. Perhaps I didn't pin all the doc dependencies the same as they appear in the default
setup.py
j
Poetry is not the problem - the Sphinx theme shipped by default is. you can try to change it for
furo
, I'm sure it will look much better
j
That's good to know, I'll try
furo
. Thanks for the help!
🙌🏼 1
j
any time! I suppose you're using
kedro build-docs
, am I right?
j
No, I built using the appropriate commands since the Kedro command is being depreciated. The aesthetics are much improved with Furo, but I'll need to refine the TOC a bit 😅
j
No, I built using the appropriate commands since the Kedro command is being depreciated.
good to know 👍🏼
but I'll need to refine the TOC a bit 😅
😄 this is outside the realm of Kedro but I have extensive experience with Sphinx, so I'm happy to help 👍🏼 also, on the
kedro build-docs
deprecation, feel free to share your thoughts here https://github.com/kedro-org/kedro/issues/2075
j
this is outside the realm of Kedro but I have extensive experience with Sphinx, so I'm happy to help 👍🏼
Thanks Juan, much appreciated. I'm new to all the documentation stuff, but I'll do what I can to learn the basics before I consider starting to hassle you!
also, on the
kedro build-docs
deprecation, feel free to share your thoughts
I'm not particularly qualified to opine on this matter, but it would be nice for the docs no0bs such as I to have a simple way to render Kedro project docs, leaving some room for theme choices, etc.
👍🏼 1
👍 1