Verified Commit aa52c253 authored by Raphaël Bleuse's avatar Raphaël Bleuse
Browse files

Warn users about obsolete documentation

parent 88420aef
......@@ -83,6 +83,13 @@ pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
rst_prolog = '''
.. warning::
PyBatsim is undergoing a comprehensive refactor.
The documentation has not been updated, and does not represent the current
state of the project.
'''
# -- Options for HTML output ----------------------------------------------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment