Skip to content

Commit 391ba12

Browse files
Add header and reorganize user_guide
1 parent c6dd902 commit 391ba12

File tree

9 files changed

+58
-23
lines changed

9 files changed

+58
-23
lines changed

doc/index.rst

+39-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,47 @@
66
:hidden:
77

88
tutorial
9-
user_guide/index.rst
10-
development_guide/index.rst
9+
10+
.. toctree::
11+
:caption: User Guide
12+
:titlesonly:
13+
:hidden:
14+
15+
user_guide/installation/index
16+
user_guide/run
17+
user_guide/output
18+
user_guide/c_extensions
19+
user_guide/messages/index
20+
user_guide/configuration/index
21+
22+
23+
.. toctree::
24+
:caption: Developer Guide
25+
:maxdepth: 2
26+
:titlesonly:
27+
:hidden:
28+
29+
development_guide/index
30+
31+
.. toctree::
32+
:caption: Additional tools
33+
:titlesonly:
34+
:hidden:
35+
1136
pyreverse
1237
symilar
38+
39+
.. toctree::
40+
:caption: Support
41+
:titlesonly:
42+
:hidden:
43+
1344
faq
1445
contact
46+
47+
.. toctree::
48+
:caption: Changelog
49+
:titlesonly:
50+
:hidden:
51+
1552
whatsnew/index.rst

doc/user_guide/index.rst

-18
This file was deleted.
File renamed without changes.

doc/user_guide/installation.rst renamed to doc/user_guide/installation/command_line_installation.rst

-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
.. _installation:
22

3-
Installation
4-
============
5-
63
Command line
74
------------
85

doc/user_guide/installation/index.rst

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Installation
2+
============
3+
4+
Pylint can be installed:
5+
6+
- As a command line tool
7+
- Integrated in your editor/ide
8+
- As a pre-commit hook
9+
10+
.. toctree::
11+
:caption: Installing pylint
12+
:maxdepth: 2
13+
:titlesonly:
14+
:hidden:
15+
16+
command_line_installation.rst
17+
ide_integration/index
18+
pre-commit-integration.rst
19+
badge

0 commit comments

Comments
 (0)