Add contributor listing

init.sh

@@ -19,6 +19,12 @@ sed -i "s|working-directory:\s*'\.'|working-directory: '$install_directory'|g" "
 echo "Updating .readthedocs.yaml configuration..."
 sed -i "s|configuration:\s*sp-docs/conf\.py|configuration: $install_directory/conf.py|g" "$temp_directory/sp-files/.readthedocs.yaml"
 sed -i "s|requirements:\s*sp-docs/\.sphinx/requirements\.txt|requirements: $install_directory/.sphinx/requirements.txt|g" "$temp_directory/.readthedocs.yaml"
+echo "Updating conf.py configuration..."
+if [ "$install_directory" == "." ]; then
+    sed -i "s|'github_folder':\s*'/sp-docs/'|'github_folder': '/'|g" "$temp_directory/sp-files/conf.py"
+else
+    sed -i "s|'github_folder':\s*'/sp-docs/'|'github_folder': '/$install_directory/'|g" "$temp_directory/sp-files/conf.py"
+fi
 
 # Create the specified installation directory if it doesn't exist
 if [ ! -d "$install_directory" ]; then

sp-files/.sphinx/requirements.txt

@@ -1,2 +1,2 @@
-canonical-sphinx
+git+https://github.com/canonical/canonical-sphinx@main#egg=canonical-sphinx
 sphinx-autobuild

sp-files/conf.py

@@ -99,7 +99,7 @@
 
     # Change to the folder that contains the documentation
     # (usually "/" or "/docs/")
-    'github_folder': '/',
+    'github_folder': '/sp-docs/',
 
     # Change to an empty value if your GitHub repo doesn't have issues enabled.
     # This will disable the feedback button and the issue link in the footer.
@@ -109,11 +109,11 @@
     # Valid options: none, prev, next, both
     # 'sequential_nav': "none",
 
-    # Controls whether to display the contributors for each file
-    # "display_contributors": True,
+    # Uncomment to disable displaying the contributors for each file.
+    # (You can also limit the time frame for displaying contributors
+    # by setting a "display_contributors_since" variable.)
+    # "display_contributors": False,
 
-    # Controls the time frame for showing the contributors
-    # "display_contributors_since": ""
 }
 
 # If your project is on documentation.ubuntu.com, specify the project