Skip to content

Commit 5f01798

Browse files
Add header and reorganize user_guide
1 parent b8bb50a commit 5f01798

File tree

9 files changed

+57
-22
lines changed

9 files changed

+57
-22
lines changed

doc/index.rst

+38-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,46 @@
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/messages/index
19+
user_guide/configuration/index
20+
21+
22+
.. toctree::
23+
:caption: Developer Guide
24+
:maxdepth: 2
25+
:titlesonly:
26+
:hidden:
27+
28+
development_guide/index
29+
30+
.. toctree::
31+
:caption: Additional tools
32+
:titlesonly:
33+
:hidden:
34+
1135
pyreverse
1236
symilar
37+
38+
.. toctree::
39+
:caption: Support
40+
:titlesonly:
41+
:hidden:
42+
1343
faq
1444
contact
45+
46+
.. toctree::
47+
:caption: Changelog
48+
:titlesonly:
49+
:hidden:
50+
1551
whatsnew/index.rst

doc/user_guide/index.rst

-17
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)