fixing docstrings and docs parsing issues

Author: oliver-zehentleitner

CHANGELOG.md

@@ -1,25 +1,29 @@
-What's New
-==========
+# lucit-backtesting Change Log
 
-These were the major changes contributing to each release:
+All notable changes to this project will be documented in this file.
 
-### 1.0.0
+The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to 
+[Semantic Versioning](http://semver.org/).
+
+[Discussions about lucit-backtesting releases!](https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/discussions/categories/releases)
+
+## 1.0.0
 (2024-06-06)
 
 Takeover of maintenance by LUCIT. The aim is an easy-to-install and functioning system.
 
 * Fix 'ValueError: Length of values (2) does not match length of index (1)' [#649](https://github.com/kernc/backtesting.py/issues/649)
 * Fix 'Plotting does not work and raises an error with Bokeh' [#1069](https://github.com/kernc/backtesting.py/issues/1069)
 
-### 0.3.3
+## 0.3.3
 (2021-12-13)
 
 * Fix random generation with recent NumPy.
 * Fix Pandas deprecation warnings.
 * Replace Bokeh 3.0 deprecations.
 
 
-### 0.3.2
+## 0.3.2
 (2021-08-03)
 
 * New strategy performance method [`backtesting.lib.compute_stats`](https://kernc.github.io/backtesting.py/doc/backtesting/lib.html#backtesting.lib.compute_stats) (#281)
@@ -30,14 +34,14 @@ Takeover of maintenance by LUCIT. The aim is an easy-to-install and functioning
 * Other small bugs and fixes.
 
 
-### 0.3.1
+## 0.3.1
 (2021-01-25)
 
 * Avoid some `pandas.Index` deprecations
 * Fix `Backtest.plot(show_legend=False)` for recent Bokeh
 
 
-### 0.3.0
+## 0.3.0
 (2020-11-24)
 
 * Faster [model-based optimization](https://kernc.github.io/backtesting.py/doc/examples/Parameter%20Heatmap%20&%20Optimization.html#Model-based-optimization) using scikit-optimize (#154)
@@ -48,34 +52,34 @@ Takeover of maintenance by LUCIT. The aim is an easy-to-install and functioning
 * Update Expectancy formula (#181)
 
 
-### 0.2.4
+## 0.2.4
 (2020-10-27)
 
 * Add [`lib.random_ohlc_data()`](https://kernc.github.io/backtesting.py/doc/backtesting/lib.html#backtesting.lib.random_ohlc_data) OHLC data generator
 * Aggregate Equity on 'last' when plot resampling
 * Update stats calculation for Buy & Hold to be long-only (#152)
 
 
-### 0.2.3
+## 0.2.3
 (2020-09-10)
 
 * Link hover crosshairs across plots
 * Clicking plot legend glyph toggles indicator visibility
 * Fix Bokeh tooltip showing literal '\ '
 
 
-### 0.2.2
+## 0.2.2
 (2020-08-21)
 
 
-### 0.2.1
+## 0.2.1
 (2020-08-03)
 
 * Add [`Trade.entry_time/.exit_time`](https://kernc.github.io/backtesting.py/doc/backtesting/backtesting.html#backtesting.backtesting.Trade)
 * Handle SL/TP hit on the same day the position was opened
 
 
-### 0.2.0
+## 0.2.0
 (2020-07-15)
 
 * New Order/Trade/Position API (#47)
@@ -87,32 +91,32 @@ Takeover of maintenance by LUCIT. The aim is an easy-to-install and functioning
 * Use geometric mean return in Sharpe/Sortino stats computation
 
 
-### 0.1.8
+## 0.1.8
 (2020-07-14)
 
 * Add Profit Factor statistic (#85)
 
 
-### 0.1.7
+## 0.1.7
 (2020-03-23)
 
 * Fix support for 2-D indicators
 * Fix tooltip Date field formatting with Bokeh 2.0.0
 
 
-### 0.1.6
+## 0.1.6
 (2020-03-09)
 
 
-### 0.1.5
+## 0.1.5
 (2020-03-02)
 
 
-### 0.1.4
+## 0.1.4
 (2020-02-25)
 
 
-### 0.1.3
+## 0.1.3
 (2020-02-24)
 
 * Show number of trades on OHLC plot legend
@@ -121,20 +125,20 @@ Takeover of maintenance by LUCIT. The aim is an easy-to-install and functioning
 * Fix pandas insertion error on Windos
 
 
-### 0.1.2
+## 0.1.2
 (2019-09-23)
 
 * Make plot span 100% of browser width
 
 
-### 0.1.1
+## 0.1.1
 (2019-09-23)
 
 * Avoid multiprocessing trouble on Windos (#6)
 * Add scatter plot indicators
 
 
-### 0.1.0
+## 0.1.0
 (2019-01-15)
 
 * Initial release

LICENSE.md

@@ -1,4 +1,4 @@
-### GNU AFFERO GENERAL PUBLIC LICENSE
+# GNU AFFERO GENERAL PUBLIC LICENSE
 
 Version 3, 19 November 2007
 
@@ -8,7 +8,7 @@ Copyright (C) 2007 Free Software Foundation, Inc.
 Everyone is permitted to copy and distribute verbatim copies of this
 license document, but changing it is not allowed.
 
-### Preamble
+## Preamble
 
 The GNU Affero General Public License is a free, copyleft license for
 software and other kinds of works, specifically designed to ensure
@@ -59,9 +59,9 @@ under this license.
 The precise terms and conditions for copying, distribution and
 modification follow.
 
-### TERMS AND CONDITIONS
+## TERMS AND CONDITIONS
 
-#### 0. Definitions.
+### 0. Definitions.
 
 "This License" refers to version 3 of the GNU Affero General Public
 License.
@@ -102,7 +102,7 @@ work under this License, and how to view a copy of this License. If
 the interface presents a list of user commands or options, such as a
 menu, a prominent item in the list meets this criterion.
 
-#### 1. Source Code.
+### 1. Source Code.
 
 The "source code" for a work means the preferred form of the work for
 making modifications to it. "Object code" means any non-source form of
@@ -143,7 +143,7 @@ regenerate automatically from other parts of the Corresponding Source.
 The Corresponding Source for a work in source code form is that same
 work.
 
-#### 2. Basic Permissions.
+### 2. Basic Permissions.
 
 All rights granted under this License are granted for the term of
 copyright on the Program, and are irrevocable provided the stated
@@ -168,7 +168,7 @@ Conveying under any other circumstances is permitted solely under the
 conditions stated below. Sublicensing is not allowed; section 10 makes
 it unnecessary.
 
-#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
 
 No covered work shall be deemed part of an effective technological
 measure under any applicable law fulfilling obligations under article
@@ -184,7 +184,7 @@ operation or modification of the work as a means of enforcing, against
 the work's users, your or third parties' legal rights to forbid
 circumvention of technological measures.
 
-#### 4. Conveying Verbatim Copies.
+### 4. Conveying Verbatim Copies.
 
 You may convey verbatim copies of the Program's source code as you
 receive it, in any medium, provided that you conspicuously and
@@ -197,7 +197,7 @@ recipients a copy of this License along with the Program.
 You may charge any price or no price for each copy that you convey,
 and you may offer support or warranty protection for a fee.
 
-#### 5. Conveying Modified Source Versions.
+### 5. Conveying Modified Source Versions.
 
 You may convey a work based on the Program, or the modifications to
 produce it from the Program, in the form of source code under the
@@ -232,7 +232,7 @@ beyond what the individual works permit. Inclusion of a covered work
 in an aggregate does not cause this License to apply to the other
 parts of the aggregate.
 
-#### 6. Conveying Non-Source Forms.
+### 6. Conveying Non-Source Forms.
 
 You may convey a covered work in object code form under the terms of
 sections 4 and 5, provided that you also convey the machine-readable
@@ -328,7 +328,7 @@ documented (and with an implementation available to the public in
 source code form), and must require no special password or key for
 unpacking, reading or copying.
 
-#### 7. Additional Terms.
+### 7. Additional Terms.
 
 "Additional permissions" are terms that supplement the terms of this
 License by making exceptions from one or more of its conditions.
@@ -387,7 +387,7 @@ Additional terms, permissive or non-permissive, may be stated in the
 form of a separately written license, or stated as exceptions; the
 above requirements apply either way.
 
-#### 8. Termination.
+### 8. Termination.
 
 You may not propagate or modify a covered work except as expressly
 provided under this License. Any attempt otherwise to propagate or
@@ -415,7 +415,7 @@ this License. If your rights have been terminated and not permanently
 reinstated, you do not qualify to receive new licenses for the same
 material under section 10.
 
-#### 9. Acceptance Not Required for Having Copies.
+### 9. Acceptance Not Required for Having Copies.
 
 You are not required to accept this License in order to receive or run
 a copy of the Program. Ancillary propagation of a covered work
@@ -426,7 +426,7 @@ modify any covered work. These actions infringe copyright if you do
 not accept this License. Therefore, by modifying or propagating a
 covered work, you indicate your acceptance of this License to do so.
 
-#### 10. Automatic Licensing of Downstream Recipients.
+### 10. Automatic Licensing of Downstream Recipients.
 
 Each time you convey a covered work, the recipient automatically
 receives a license from the original licensors, to run, modify and
@@ -451,7 +451,7 @@ rights granted under this License, and you may not initiate litigation
 any patent claim is infringed by making, using, selling, offering for
 sale, or importing the Program or any portion of it.
 
-#### 11. Patents.
+### 11. Patents.
 
 A "contributor" is a copyright holder who authorizes use under this
 License of the Program or a work on which the Program is based. The
@@ -520,7 +520,7 @@ Nothing in this License shall be construed as excluding or limiting
 any implied license or other defenses to infringement that may
 otherwise be available to you under applicable patent law.
 
-#### 12. No Surrender of Others' Freedom.
+### 12. No Surrender of Others' Freedom.
 
 If conditions are imposed on you (whether by court order, agreement or
 otherwise) that contradict the conditions of this License, they do not
@@ -533,7 +533,7 @@ from those to whom you convey the Program, the only way you could
 satisfy both those terms and this License would be to refrain entirely
 from conveying the Program.
 
-#### 13. Remote Network Interaction; Use with the GNU General Public License.
+### 13. Remote Network Interaction; Use with the GNU General Public License.
 
 Notwithstanding any other provision of this License, if you modify the
 Program, your modified version must prominently offer all users
@@ -554,7 +554,7 @@ License will continue to apply to the part which is the covered work,
 but the work with which it is combined will remain governed by version
 3 of the GNU General Public License.
 
-#### 14. Revised Versions of this License.
+### 14. Revised Versions of this License.
 
 The Free Software Foundation may publish revised and/or new versions
 of the GNU Affero General Public License from time to time. Such new
@@ -580,7 +580,7 @@ permissions. However, no additional obligations are imposed on any
 author or copyright holder as a result of your choosing to follow a
 later version.
 
-#### 15. Disclaimer of Warranty.
+### 15. Disclaimer of Warranty.
 
 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
 APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
@@ -592,7 +592,7 @@ PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
 DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
 CORRECTION.
 
-#### 16. Limitation of Liability.
+### 16. Limitation of Liability.
 
 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
@@ -604,7 +604,7 @@ LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
 TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
 PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 
-#### 17. Interpretation of Sections 15 and 16.
+### 17. Interpretation of Sections 15 and 16.
 
 If the disclaimer of warranty and limitation of liability provided
 above cannot be given local legal effect according to their terms,
@@ -615,7 +615,7 @@ copy of the Program in return for a fee.
 
 END OF TERMS AND CONDITIONS
 
-### How to Apply These Terms to Your New Programs
+## How to Apply These Terms to Your New Programs
 
 If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it