Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes significant changes to the documentation configuration and structure for the
fabric-cicd
project. The changes primarily focus on setting up the Read the Docs configuration, organizing the Sphinx documentation, and updating the README file.Documentation configuration and structure:
.readthedocs/config/build_local.ps1
: Added a PowerShell script to build and serve the Sphinx documentation locally..readthedocs/config/conf.py
: Configured Sphinx documentation settings, including project information, extensions, and theme..readthedocs/config/readthedocs.yml
: Added Read the Docs configuration file specifying the build environment and Python version..readthedocs/config/requirements.txt
: Listed the required packages for building the documentation.Documentation content updates:
.readthedocs/docs/index.rst
: Created the main index file for the documentation with a table of contents..readthedocs/docs/installation.rst
: Added installation instructions for thefabric-cicd
package..readthedocs/docs/library_reference/fabric_workspace.rst
: Documented thefabric_workspace
module..readthedocs/docs/library_reference/index.rst
: Created an index for the library reference section..readthedocs/docs/library_reference/publish.rst
: Documented thepublish
module..readthedocs/docs/overview.rst
: Included the project overview from the README file..readthedocs/docs/usage.rst
: Added usage examples for various functionalities of thefabric-cicd
package.README and support updates:
README.md
: Updated the project overview, added new badges, and revised the content to provide more detailed information about the project, including authentication, contributing, and support sections. [1] [2]SUPPORT.md
: Removed the support instructions, as they are now included in the README file.Removed old documentation files:
docs/Makefile
,docs/make.bat
,docs/source/conf.py
,docs/source/index.rst
,docs/source/modules.rst
,docs/source/requirements.txt
,readthedocs.yml
: Removed outdated Sphinx configuration and documentation files. [1] [2] [3] [4] [5] [6] [7]