Skip to content

Commit 131f729

Browse files
Initial README.rst
1 parent ee64d37 commit 131f729

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

‎README.rst‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,61 @@
1+
-------------------------------------------
2+
Fork of the official ``readthedocs/sphinx_rtd_theme`` repo.
3+
-------------------------------------------
4+
5+
``work in progress...``
6+
7+
^^^^^^^^^^^^^^^^
8+
Original repo
9+
^^^^^^^^^^^^^^^^
10+
11+
* https://github.com/readthedocs/sphinx_rtd_theme
12+
13+
^^^^^^^^^^^^^^^^
14+
About this Fork
15+
^^^^^^^^^^^^^^^^
16+
17+
Goal is to...
18+
19+
* create a ``pip`` installable theme that users can download locally
20+
21+
Steps to use once complete:
22+
23+
* Checkout the official Python docs
24+
* Edit ``cpython/Doc/config.py`` Sphinx Configuration file to reference this new ``python_rtd_theme``
25+
* Then build the official Python Docs locally, get a website with a true TOC ("Table of Contents") sidebar.
26+
27+
^^^^^^^^^^^^
28+
Related Repos
29+
^^^^^^^^^^^^
30+
31+
* https://github.com/python-docs-101/Python-Documentation-Theme-Fork
32+
33+
* ``cpython`` fork, used to re-build official docs using Read The Docs theme
34+
35+
* https://github.com/python-docs-101/python-docs-101.github.io
36+
37+
* GitHub Pages website hosting the output of the fork of the official docs.
38+
39+
40+
^^^^^^^^^^^^
41+
Product
42+
^^^^^^^^^^^^
43+
| Official Docs with TOC Sidebar:
44+
| https://python-docs-101/python-docs-101.github.io
45+
46+
47+
|
48+
|
49+
|
50+
|
51+
|
52+
| Original readme below this line
53+
|
54+
|
55+
|
56+
|
57+
|
58+
159
**************************
260
Read the Docs Sphinx Theme
361
**************************

0 commit comments

Comments
 (0)