Skip to content

Commit

Permalink
Include python docs in devguide index (#20917)
Browse files Browse the repository at this point in the history
Python docs were not included on any page, and thus not generated in the
final docs.
  • Loading branch information
jsoriano authored Sep 2, 2020
1 parent 99fd545 commit 13d20fe
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 2 additions & 0 deletions docs/devguide/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ include::./fields-yml.asciidoc[]

include::./event-conventions.asciidoc[]

include::./python.asciidoc[]

include::./newdashboards.asciidoc[]

include::./new_protocol.asciidoc[]
Expand Down
8 changes: 4 additions & 4 deletions docs/devguide/python.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[python-beats]]
== Python in Beats
=== Python in Beats

Python is used for Beats development, it is the language used to implement
system tests and some other tools. Python dependencies are managed by the use of
Expand All @@ -9,7 +9,7 @@ https://docs.python.org/3/library/venv.html[venv].
Beats development requires Python >= {python}.

[[installing-python]]
=== Installing Python and venv
==== Installing Python and venv

Python uses to be installed in many operating systems. If it is not installed in
your system you can follow the instructions available in https://www.python.org/downloads/
Expand All @@ -32,7 +32,7 @@ sudo apt-get install python3.7 python3.7-venv
It is recommended to use Python >= {python}.

[[python-virtual-environments]]
=== Working with virtual environments
==== Working with virtual environments

All `make` and `mage` targets manage their own virtual environments in a transparent
way, so for the most common operations required when contributing to beats,
Expand Down Expand Up @@ -65,7 +65,7 @@ To recreate a virtual environment, remove its directory. All virtual
environments are also removed with `make clean`.

[[python-older-versions]]
=== Working with older versions
==== Working with older versions

Older versions of Beats were not compatible with Python 3, if you need to
temporary work on one of these versions of Beats, and you don't want to remove
Expand Down

0 comments on commit 13d20fe

Please sign in to comment.