Skip to content
This repository has been archived by the owner on Jul 20, 2023. It is now read-only.

Commit

Permalink
add sphinx apidoc compatibility to doc config
Browse files Browse the repository at this point in the history
  • Loading branch information
mattbev committed Jul 12, 2021
1 parent 13dfe6f commit f342c3b
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 3 deletions.
Empty file added _static/.placeholder
Empty file.
29 changes: 27 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,37 @@

sys.path.insert(0, os.path.abspath('../'))

import sphinx.apidoc
def setup(app):
# app.add_javascript('copybutton.js')
sphinx.apidoc.main(['-f', #Overwrite existing files
'-T', #Create table of contents
'-e', #Give modules their own pages
#'-E', #user docstring headers
#'-M', #Modules first
'-o', #Output the files to:
'./_autogen/', #Output Directory
'./../finpandas', #Main Module directory
]
)


# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False


# -- Project information -----------------------------------------------------

project = 'finpandas'
copyright = '2021, Matthew Beveridge'
author = 'Matthew Beveridge'


# the short version
version = 'v0.1'
# The full version, including alpha/beta/rc tags
release = '0.1.0'
release = '0.1.0alpha'


# -- General configuration ---------------------------------------------------
Expand All @@ -42,6 +64,9 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# main page
master_doc = 'index'


# -- Options for HTML output -------------------------------------------------

Expand All @@ -56,7 +81,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
html_static_path = ['_static']

# favicon
# html_favicon = "black_minimal.ico"
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
finpandas Software Reference Manual
===========================================
===================================

Public financial analysis tools in Python.

Expand Down

0 comments on commit f342c3b

Please sign in to comment.