Merge pull request #139 from fastai/fix-settings

Fix settings

Author: Hamel Husain

.github/workflows/setup.yaml

@@ -19,18 +19,28 @@ jobs:
       run: |
         import re, os
         from pathlib import Path
+        from configparser import ConfigParser
+        config = ConfigParser()
 
         nwo = os.getenv('GITHUB_REPOSITORY')
         username, repo_name = nwo.split('/')
         readme_template_path = Path('README_TEMPLATE.md')
         readme_path = Path('README.md')
         config_path = Path('_config.yml')
         pr_msg_path = Path('_setup_pr_template.md')
+        settings = Path('_action_files/settings.ini')
 
         assert readme_template_path.exists(), 'Did not find README_TEMPLATE.md in the current directory!'
         assert readme_path.exists(), 'Did not find README.md in the current directory!'
         assert config_path.exists(), 'Did not find _config.yml in the current directory!'
         assert pr_msg_path.exists(), 'Did not find _setup_pr_template.md in the current directory!'
+        assert settings.exists(), 'Did not find _action_files/settings.ini in the current directory!'
+        
+        # edit settings.ini file to inject baseurl
+        config.read(settings)
+        config['DEFAULT']['baseurl'] = repo_name
+        with open('_action_files/settings.ini', 'w') as configfile:
+          config.write(configfile)
 
         # replace content of README with template
         readme = readme_template_path.read_text().replace('{_username_}', username).replace('{_repo_name_}', repo_name)
@@ -58,7 +68,7 @@ jobs:
         git rm _notebooks/2020-02-21-introducing-fastpages.ipynb
         git rm .github/workflows/chatops.yaml
         git rm -rf .github/ISSUE_TEMPLATE
-        git add _config.yml README.md _setup_pr_template.md
+        git add _config.yml README.md _setup_pr_template.md _action_files/settings.ini
         git commit -m'setup repo'
         git push -f --set-upstream origin fastpages-automated-setup
       env: 

Makefile

@@ -2,27 +2,27 @@ help:
 	cat Makefile
 
 # start (or restart) the services
-server:
+server: .FORCE
 	docker-compose down || true;
 	docker-compose up
 
 # start (or restart) the services in detached mode
-server-detached:
+server-detached: .FORCE
 	docker-compose down || true;
 	docker-compose up -d
 
 # build or rebuild the services WITHOUT cache
-build:
+build: .FORCE
 	docker-compose stop || true; docker-compose rm || true;
 	docker-compose build --force-rm --no-cache
 
 # rebuild the services WITH cache
-quick-build:
+quick-build: .FORCE
 	docker-compose stop || true;
 	docker-compose build 
 
 # convert word & nb without Jekyll services
-convert:
+convert: .FORCE
 	docker-compose up converter
 
 # stop all containers

_action_files/settings.ini

@@ -7,6 +7,7 @@ description = Writing a library entirely in notebooks
 keywords = jupyter notebook
 author = Sylvain Gugger and Jeremy Howard
 author_email = [email protected]
+baseurl = 
 title = nbdev
 copyright = fast.ai
 license = apache2
@@ -32,10 +33,11 @@ console_scripts = nbdev_build_lib=nbdev.cli:nbdev_build_lib
 nbs_path = nbs
 doc_path = images/copied_from_nb
 doc_host = https://nbdev.fast.ai
-doc_baseurl = {{site.baseurl}}/images/copied_from_nb/
+doc_baseurl = %(baseurl)s/images/copied_from_nb/
 git_url = https://github.com/fastai/nbdev/tree/master/
 lib_path = nbdev
 tst_flags = fastai2
 custom_sidebar = False
 cell_spacing = 1
 monospace_docstrings = False
+

_config.yml

@@ -13,8 +13,28 @@ github_username: fastai
 github_repo: "fastpages"
 
 # OPTIONAL: override baseurl and url if using a custom domain
+# Note: leave out the trailing / from this value. 
 url: "https://fastpages.fast.ai" # the base hostname & protocol for your site, e.g. http://example.com
-baseurl: "" # the subpath of your site, e.g. "/blog".  WARNING: if you are not using a custom domain, the baseurl *must* be set to your repo name.
+
+###########################################################
+#########  Special Instructions for baseurl ###############
+#
+#### Scenario One: If you do not have a Custom Domain #####
+#    -  if you are not using a custom domain, the baseurl *must* be set to your repo name
+# 
+####  Scenario Two: If you have a Custom Domain #####
+# 1. If your domain does NOT have a subpath, this leave this value as ""
+# 2. If your domain does have a subpath, you must preceed the value with a / and NOT have a / at the end.  
+#      For example: 
+#           "" is valid
+#           "/blog"        is valid
+#            "/blog/site/" is invalid  ( / at the end)
+#            "/blog/site"  is valid
+#            "blog/site"   is invalid  ( because doesn't begin with a /)
+#
+# 3. You must replace the parameter `baseurl` in _action_files/settings.ini with the same value as you set here but WITHOUT QUOTES.
+#
+baseurl: "" # the subpath of your site, e.g. "/blog".
 
 # Email and twitter are optional:
 email: 

_includes/image

@@ -0,0 +1,8 @@
+<figure>
+  {% if {{include.url}} %}<a class="no_icon" target="_blank" href="{{include.url}}">{% endif %}
+    <img class="docimage" src="{{include.file}}" alt="{{include.alt}}" {% if {{include.max-width}} %}style="max-width: {{include.max-width}}px"{% endif %} />
+    {% if {{include.url}} %}</a>{% endif %}
+    {% if {{include.caption}} %}
+      <figcaption>{{include.caption}}</figcaption>
+    {% endif %}
+</figure>