Skip to content

Commit

Permalink
improving new docs;
Browse files Browse the repository at this point in the history
  • Loading branch information
enzbus committed May 13, 2024
1 parent c63ccfc commit 2ca97fe
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 7 deletions.
4 changes: 1 addition & 3 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ API documentation

simulator
policies
returns
risks
costs
objective_terms
constraints
result
data
Expand Down
27 changes: 25 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,29 @@
#
html_theme = 'pydata_sphinx_theme'

# PYDATA_SPHINX_THEME configuration

html_sidebars = { # disable left sidebar on certain pages
"manual": [],
"contributing": []
}

html_theme_options = { # button to let users send PR to GH
"use_edit_page_button": True,
}

html_context = {
"github_url": "https://github.com",
"github_user": "cvxgrp",
"github_repo": "cvxportfolio",
"github_version": "master", # don't know if can point to tag of the page?
"doc_path": "docs",
}

# however this seems confusing to me
# html_show_sourcelink = False


# not used by FURO
# html_theme_options = {
# "source_repository": REPO,
Expand Down Expand Up @@ -159,7 +182,7 @@
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'cvxportfolio.tex', 'Cvxportfolio Documentation',
'The Cvxportfolio Contributors', 'manual'),
'The Cvxportfolio Authors and Contributors', 'manual'),
]


Expand All @@ -180,6 +203,6 @@
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'cvxportfolio', 'Cvxportfolio Documentation',
author, 'cvxportfolio', 'One line description of project.',
author, 'cvxportfolio', 'Portfolio Optimization and Back-Testing.',
'Miscellaneous'),
]
4 changes: 2 additions & 2 deletions docs/constraints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ can not be used as soft constraints. See their documentation for more details.
Cost inequality as constraint
-----------------------------

Since version ``0.4.6`` you can use any term described in
:ref:`the objective terms page <objective-terms-page>` as part
Since version ``0.4.6`` you can use any objective function term,
such as :doc:`returns`, :doc:`risks`, and :doc:`costs`, as part
of an inequality constraint.
In fact, you can use any linear combination of objective terms.
For a minimal example see the following risk-constrained policy.
Expand Down

0 comments on commit 2ca97fe

Please sign in to comment.