bs4 / beautifulsoup4 docs example generated by sphinx-autoapi + furo theme
Online demo: https://cmdlineluser.github.io/beautifulsoup4-docs/
![Screenshot 2023-08-05 at 13 56 31](https://private-user-images.githubusercontent.com/99486669/258585833-26ff0f77-d221-40d0-962a-b5f2a8b85d85.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjYwMzc3NDEsIm5iZiI6MTcyNjAzNzQ0MSwicGF0aCI6Ii85OTQ4NjY2OS8yNTg1ODU4MzMtMjZmZjBmNzctZDIyMS00MGQwLTk2MmEtYjVmMmE4Yjg1ZDg1LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA5MTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwOTExVDA2NTA0MVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTNjOWE2ZDM4NTYwNTcwYzY5NjQ4ODA4NmYxYTI3Njk3MTJkY2IwMzk3NjFiNTRkZmM4NjU0MWEzYzI1MWMzNjImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.kcR1lJmUReu4NemNislt0N7F5XWotpoJppKRbR5Paj8)
Created with https://github.com/readthedocs/sphinx-autoapi
python3 -m pip install sphinx sphinx-autoapi furo
wget https://www.crummy.com/software/BeautifulSoup/bs4/download/4.12/beautifulsoup4-4.12.2.tar.gz
tar xf beautifulsoup4-4.12.2.tar.gz
cd beautifulsoup4-4.12.2/
I then ran:
sphinx-quickstart docs
I then edited docs/source/conf.py
to use autoapi and the furo
theme:
extensions = ['autoapi.extension']
autoapi_dirs = ['../../bs4']
html_theme = 'furo'
I then ran:
sphinx-build -b html docs/source docs/build
This then creates docs/build/index.html