diff --git a/Contributing.rst b/Contributing.rst index 3212937..01d046d 100644 --- a/Contributing.rst +++ b/Contributing.rst @@ -193,20 +193,20 @@ Update version strings Version strings need to be updated in * setup.py - * sphinx/conf.py + * docs/conf.py * __init__.py * Changelog.md Make sure that new functions/methods/classes are included to the documentation ------------------------------------------------------------------------------ -The text file sphinx/transistordatabase.rst contains all functions that will be shown in the documentation build by sphinx. Make sure that this list ist up-to-date when releasing a new version. +The text file docs/transistordatabase.rst contains all functions that will be shown in the documentation build by sphinx. Make sure that this list ist up-to-date when releasing a new version. Build a local test-documentation -------------------------------- First, generate the sphinx documentation for the current version to see if this runs without any errors. -Go to /sphinx and runs +Go to /docs and runs .. code-block:: @@ -222,9 +222,9 @@ Next, generate the sphinx-multiversion documentation for all available versions .. code-block:: - sphinx-multiversion sphinx sphinx/_build/_html + sphinx-multiversion sphinx docs/_build/_html -Make sure the html-generation works without errors and visit the generated file inside /spinx/_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:: @@ -291,20 +291,20 @@ generate sphinx documentation on github pages .. code-block:: # make sure to clean up old build data - cd sphinx/ + cd docs/ make clean cd .. - sphinx-multiversion sphinx sphinx/_build/_html + sphinx-multiversion sphinx docs/_build/_html # write the new documentation to github-pages git checkout gh-pages - # now, copy the files from sphinx/_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 # change back to the main branch git checkout main # clean up old build data - cd sphinx + cd docs make clean .. |br| raw:: html diff --git a/docs/conf.py b/docs/conf.py index 5455839..1639c6a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,7 +29,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. sys.path.insert(0, os.path.abspath('_extensions')) -extensions = ['sphinxcontrib.email', 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.todo', 'sphinx_rtd_theme'] # 'sphinx_multiversion' +extensions = ['sphinxcontrib.email', 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.todo', 'sphinx_rtd_theme'] # 'sphinx_multiversion' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']