Navigation

    Backtrader Community

    • Register
    • Login
    • Search
    • Categories
    • Recent
    • Tags
    • Popular
    • Users
    • Groups
    • Search
    For code/output blocks: Use ``` (aka backtick or grave accent) in a single line before and after the block. See: http://commonmark.org/help/

    Any reasonably organized reference documentation?

    General Discussion
    3
    3
    421
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • A
      Alexan last edited by

      I'm pretty frustrated with the organization of the documentation.

      For instance, look at this page:

      https://www.backtrader.com/docu/indautoref.html

      • The left column is a list of pages of varying topics and depths in a seemingly random order.

      • The search is ineffective in finding reference documentation, e.g. "where is the strategy reference docs".

      • There is no index to for the functions (!WTF?!). The only way to find a function documentation is to use in-page search, which is ineffective for common terms like "Average".

      It seems like great effort has been put into the documentation and there is so much there, it's a shame it isn't organized in a usable way, particularly for developers just needing API reference documentation.

      Am I missing something?

      B 1 Reply Last reply Reply Quote 0
      • A
        ab_trader last edited by ab_trader

        Since you are the first person here complaining about documentation, than you are definitely missing something. And this is really annoying.

        I think you are missing the point that all of this - code, docs, web site - was done by single person in his free time and given to you for free.

        You can stop use of backtrader anytime if it causes you so much pain.

        • If my answer helped, hit reputation up arrow at lower right corner of the post.
        • Python Debugging With Pdb
        • New to python and bt - check this out
        1 Reply Last reply Reply Quote 0
        • B
          backtrader administrators @Alexan last edited by

          @alexan said in Any reasonably organized reference documentation?:

          Am I missing something?

          Yes you are.

          1. You could make proposals and not simply criticize.

          2. You could fund a project to get new documentation written in a way you think it's proper.

          1 Reply Last reply Reply Quote 0
          • 1 / 1
          • First post
            Last post
          Copyright © 2016, 2017, 2018, 2019, 2020, 2021 NodeBB Forums | Contributors