Merge pull request #189 from consideRatio/rename-nbgitpuller-repos-ma…

…ster-branch-to-main

Rename nbgitpuller repo's master branch to main

.circleci/config.yml

@@ -34,9 +34,9 @@ workflows:
       - build_docs
       - push_docs:
           filters:  # using regex filters requires the entire branch to match
-              branches:
-                only:  # only branches matching the below regex filters will run
-                  - master
+            branches:
+              only:  # only branches matching the below regex filters will run
+                - main
 
 commands:
   build_site:
@@ -62,4 +62,4 @@ commands:
           name: Build docs to store
           command: |
             cd docs
-            make html
+            make html

RELEASE.md

@@ -9,13 +9,13 @@ The PyPI release is done automatically by TravisCI when a tag is pushed.
 
 ## Steps to make a release
 
-1. Checkout master and make sure it is up to date.
+1. Checkout main and make sure it is up to date.
 
    ```shell
    ORIGIN=${ORIGIN:-origin} # set to the canonical remote, e.g. 'upstream' if 'origin' is not the official repo
-   git checkout master
-   git fetch $ORIGIN master
-   git reset --hard $ORIGIN/master
+   git checkout main
+   git fetch $ORIGIN main
+   git reset --hard $ORIGIN/main
    # WARNING! This next command deletes any untracked files in the repo
    git clean -xfd
    ```
@@ -38,15 +38,15 @@ The PyPI release is done automatically by TravisCI when a tag is pushed.
    git commit -m "back to dev"
    ```
 
-1. Push your two commits to master.
+1. Push your two commits to main.
 
    ```shell
    # first push commits without a tags to ensure the
    # commits comes through, because a tag can otherwise
    # be pushed all alone without company of rejected
    # commits, and we want have our tagged release coupled
-   # with a specific commit in master
-   git push $ORIGIN master
+   # with a specific commit in main
+   git push $ORIGIN main
    ```
 
 1. Create a git tag for the pushed release commit and push it.

docs/conf.py

@@ -32,8 +32,8 @@ def setup(app):
 source_suffix = [".rst", ".md"]
 
 
-# The master toctree document.
-master_doc = "index"
+# The root toctree document.
+root_doc = master_doc = "index"
 
 # General information about the project.
 project = "nbgitpuller"
@@ -85,7 +85,7 @@ def setup(app):
 html_context = {
     "github_user": "jupyterhub",
     "github_repo": "nbgitpuller",
-    "github_version": "master",
+    "github_version": "main",
     "doc_path": "doc",
     "source_suffix": source_suffix,
 }
@@ -130,7 +130,7 @@ def setup(app):
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (
-        master_doc,
+        root_doc,
         "nbgitpuller.tex",
         "nbgitpuller Documentation",
         "The nbgitpuller Team",
@@ -143,7 +143,7 @@ def setup(app):
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "nbgitpuller", "nbgitpuller Documentation", [author], 1)]
+man_pages = [(root_doc, "nbgitpuller", "nbgitpuller Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -153,7 +153,7 @@ def setup(app):
 #  dir menu entry, description, category)
 texinfo_documents = [
     (
-        master_doc,
+        root_doc,
         "nbgitpuller",
         "nbgitpuller Documentation",
         author,