Skip to content

Commit

Permalink
fix documentation pipeline filepath issue
Browse files Browse the repository at this point in the history
  • Loading branch information
gituser789 committed Jun 22, 2024
1 parent 43d88cc commit d506079
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 9 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0


## [Unreleased] - Date
### Fixed
- Documentation pipeline issue

## [0.5.0] - 2024-06-22
### Added
- Non-linear capacitance file export for GeckoCIRCUITS
Expand Down
12 changes: 6 additions & 6 deletions Contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ Step 2: Configure the conf.py file with necessary extensions.

Step 3: Create the necessary .rst files like _introduction, installation, transistordatabase and add the tree structure in index.rst.

Step 4: Point to folder where Makefile exists and execute command **"make html"** to generate documentation. The generated HTML files will be placed under _build\html folder.
Step 4: Point to folder where Makefile exists and execute command **"make html"** to generate documentation. The generated HTML files will be placed under build\html folder.

For generating multiversion documentation, py module ``sphinx-multiversion`` is used and added as extension in conf.py.
Further steps about configuring the project to enable multiversioning documentation can be found `here <https://holzhaus.github.io/sphinx-multiversion/master/quickstart.html>`__.
Expand Down Expand Up @@ -212,7 +212,7 @@ Go to /docs and runs
make html
Make sure the html-generation works without errors and visit the generated file inside /spinx/_build/_html/index.html
Make sure the html-generation works without errors and visit the generated file inside /spinx/build/html/index.html

.. code-block::
Expand All @@ -222,9 +222,9 @@ Next, generate the sphinx-multiversion documentation for all available versions

.. code-block::
sphinx-multiversion sphinx docs/_build/_html
sphinx-multiversion sphinx docs/build/html
Make sure the html-generation works without errors and visit the generated file inside /docs/_build/_html/main/index.html
Make sure the html-generation works without errors and visit the generated file inside /docs/build/html/main/index.html

.. note::

Expand Down Expand Up @@ -294,10 +294,10 @@ generate sphinx documentation on github pages
cd docs/
make clean
cd ..
sphinx-multiversion sphinx docs/_build/_html
sphinx-multiversion sphinx docs/build/html
# write the new documentation to github-pages
git checkout gh-pages
# now, copy the files from docs/_build/_html to the gh-pages repository
# now, copy the files from docs/build/html to the gh-pages repository
git add #newChangesHere
git commit -m "update docu"
git push
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ['build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
Expand Down
2 changes: 1 addition & 1 deletion docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
set BUILDDIR=build

if "%1" == "" goto help

Expand Down

0 comments on commit d506079

Please sign in to comment.