Skip to content

Commit 97975dc

Browse files
bhk11annava1mounica3003
authored
Sphinx doc (#272)
* Updated gem-elecrtric-motor with gem-control docs * Delete src/debug.ipynb * Delete eesm file * Add debug.ipynb to .gitignore * test * deletion of readme file * Syntax changed - 2 files * try to fix the index.rst * further changes to the index.rst and delete unnecessary .rst files * fixed a typo in the file name * change in the index.rst * fix gem_control.rst * delete the not necessary parts folder and try to add some text to gem_controllers.rst to generate at least the html page. * fix error in the do build * try another path to enable the full doc build * try to exclude block_diagrams/block_diagrams because of the warning in the build log * deleted the parts of gem control in the gem docs and revert the change in the gem_controllers.rst * try some fix * Added the title to all rst files to fix the missing link in the docs * add installation of block diagramms into the doc building process * add git to the build process of the docs * try to fix install of Control Block Diagramms in the doc build process * fix for missing git command * try to fix import error of the gem-control functions * revert change because of other error * checked all warning logs in sphinx doc * try to import using tk * installed control package * exclude JOSS error * installed ipython * made some changes to build and conf file * added extensions * restored confy file * pre-build command change * added && * Import error of matlab plot * tried command * missing os libs * print hidden log * application error * python traceback * bypass wrapper * reverting the recent changes * compatible version * changing libs error * adding mdinclude * installing mdinclude * reverting the changes in build * testing mdinclude * removing m2r2 * making docutils as 0.19 * pinning older theme * changing theme in confy * correcting theme package name * editing the build * avoiding sphinx version * pinning version as 4.5.0 * fixing error sphinxcontrib.applehelp * pinning docutils * updating sphinx theme * correcting incompatible errors * pinning older sphinx * using wrapper action * updating docutils * removing sphinx action * merge block and build docs * fixing static missing error * fixing automethid error * change in operation point rst * using preamble instead of latex * remove the localdir message * fixing the attribute in exter_dc rst * fixing docstring * fixing block errors * using autodoc on module * toctree listing * fixing module path * Fixing GEM controller * Fixing mismatching file name * Fixing the review comments * Fixing constraint * fixing build doc * fixing current module error * suppressing warnings * renaming readme file * removing waring * Re-enable the rst * fixing upstream docstrings * removing warnings * Add missing files from the sixphase again * fixing some names of the envs * removed an unnecessary file * fixing tree --------- Co-authored-by: annava1 <annavall@campus.uni-paderborn.de> Co-authored-by: mounica3003 <mounicav3003@gmail.com>
1 parent 8dbd89f commit 97975dc

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

docs/conf.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,11 @@
125125
# further. For a list of options available for each theme, see the
126126
# documentation.
127127
#
128-
# html_theme_options = {}
128+
html_theme_options = {
129+
"collapse_navigation": False, # keep the tree expanded (optional)
130+
"navigation_depth": 4, # how deep the *page* tree goes
131+
"titles_only": True,
132+
}
129133

130134
# Add any paths that contain custom static files (such as style sheets) here,
131135
# relative to this directory. They are copied after the builtin static files,

0 commit comments

Comments
 (0)