fabrice/mediacurator
fabrice/mediacurator
1
0
Fork 0
Code Projects Releases Activity

Fix makedocs script to run from project root and update 1.0.1 release notes

Browse Source 
- Modified makedocs script to allow execution from the project root directory, updating paths for source and build directories.
- Fixed a missing sentence in the 1.0.1 release notes, ensuring clarity and completeness in the changelog documentation.
This commit is contained in:
Fabrice Quenneville 2024-10-17 20:20:12 -04:00
parent 448c673385
commit 5ad78b33f2
5 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/_sources/releasenotes/1.0.1-changelog.rst.txt
View File

@ -11,7 +11,7 @@ Dropped Support
Compatibility Notes Compatibility Notes
==================== ====================
* Renamed * **Renamed the project** from 'MediaCurator' to 'mediacurator' to standardize naming conventions (all lowercase).
Python Support Python Support
-------------- --------------

2
docs/releasenotes/1.0.1-changelog.html
View File

@ -45,7 +45,7 @@
<section id="compatibility-notes"> <section id="compatibility-notes">
<h2>Compatibility Notes<a class="headerlink" href="#compatibility-notes" title="Link to this heading"></a></h2> <h2>Compatibility Notes<a class="headerlink" href="#compatibility-notes" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Renamed</p></li> <li><p><strong>Renamed the project</strong> from ‘MediaCurator’ to ‘mediacurator’ to standardize naming conventions (all lowercase).</p></li>
</ul> </ul>
<section id="python-support"> <section id="python-support">
<h3>Python Support<a class="headerlink" href="#python-support" title="Link to this heading"></a></h3> <h3>Python Support<a class="headerlink" href="#python-support" title="Link to this heading"></a></h3>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

22
docsource/makedocs
View File

@ -1,22 +1,22 @@
#!/bin/bash #!/bin/bash
source_path=$(readlink -f ../docs/) # Set paths relative to the root directory (.)
docs_path=$(readlink -f ../docs/) source_path=$(readlink -f ./docsource/source/)
docs_path=$(readlink -f ./docs/)
red='\033[0;31m' red='\033[0;31m'
cyan='\033[0;36m' cyan='\033[0;36m'
nc='\033[0m' nc='\033[0m'
printf "${cyan}Cleaning${nc} docs and build directories.\n" printf "${cyan}Cleaning${nc} docs and build directories.\n"
find ../docs -mindepth 1 -delete find ./docs -mindepth 1 -delete
find ./build -mindepth 1 -delete find ./docsource/build -mindepth 1 -delete
printf "${cyan}Generating${nc} sphinx build.\n" printf "${cyan}Generating${nc} sphinx build.\n"
sphinx-build -b html source build sphinx-build -b html $source_path ./docsource/build
printf "${cyan}Prepping${nc} for release.\n" printf "${cyan}Prepping${nc} for release.\n"
cp -r ./build/* ../docs/ cp -r ./docsource/build/* ./docs/
touch ../docs/.nojekyll touch ./docs/.nojekyll
printf "${cyan}Cleaning${nc} up and setting proper permissions\n" printf "${cyan}Cleaning${nc} up and setting proper permissions\n"
find ../docs/ -type d -exec chmod 755 {} \; find ./docs/ -type d -exec chmod 755 {} \;
find ../docs/ -type f -exec chmod 644 {} \; find ./docs/ -type f -exec chmod 644 {} \;
find ./build -mindepth 1 -delete find ./docsource/build -mindepth 1 -delete
printf "Documentation ${cyan}ready for release${nc} in: ${red}${docs_path}${nc}\n" printf "Documentation ${cyan}ready for release${nc} in: ${red}${docs_path}${nc}\n"

2
docsource/source/releasenotes/1.0.1-changelog.rst
View File

@ -11,7 +11,7 @@ Dropped Support
Compatibility Notes Compatibility Notes
==================== ====================
* Renamed * **Renamed the project** from 'MediaCurator' to 'mediacurator' to standardize naming conventions (all lowercase).
Python Support Python Support
-------------- --------------