Snippets

FEniCS Project How to create a new FEniCS featured article

Updated by Marie Elisabeth Rognes
View revision

File How to create a new FEniCS featured article Modified

  • Ignore whitespace
  • Hide word diff 
 
 # Find a nice image for the slider bar of the right size, namely
 # 366x282 and place it under
-# ./source/_static/images/featured/<YYYY/featured_item_xyz.png>
+# ./source/_static/images/featured/featured_item_xyz.png>
 # Remember to git add it while you are at it
-git add ./source/_static/images/featured/<YYYY/featured_item_xyz.png>
+git add ./source/_static/images/featured/featured_item_xyz.png>
 
 # Update the main index page by updating the list of slider items in
 # ./source/index.inc (Just copy and paste one of the other items and
Updated by Marie Elisabeth Rognes
View revision

File How to create a new FEniCS featured article Modified

  • Ignore whitespace
  • Hide word diff 
 # Find a nice image for the slider bar of the right size, namely
 # 366x282 and place it under
 # ./source/_static/images/featured/<YYYY/featured_item_xyz.png>
+# Remember to git add it while you are at it
 git add ./source/_static/images/featured/<YYYY/featured_item_xyz.png>
 
 # Update the main index page by updating the list of slider items in
 # ./source/index.inc (Just copy and paste one of the other items and
-# update the references). And then commit it:
+# update the references). And then commit the slider bar updates. 
 git commit -a
 
 # Finally, make a pull request to FEniCS-web. Congratulations, mission
 # accomplished!
 
 # Alternatively, for FEniCS-web admins, do:
+make clean
 make web
 make publish
+
 # Merge and push your changes
Updated by Marie Elisabeth Rognes
View revision

File How to create a new FEniCS featured article Added

  • Ignore whitespace
  • Hide word diff 
+###################################################################
+The complete guide to 'How to create a new FEniCS featured article'
+###################################################################
+
+# Get the FEniCS web source code:
+git clone git@bitbucket.org:fenics-project/fenics-web.git
+
+# Go there
+cd fenics-web
+
+# Checkout out your new featured article branch:
+git checkout -b user/featured-article-<xyz>
+
+# Read the README so that you have done that
+cat README.rst
+
+# The source for the featured articles is located under
+#  ./source/featured/<YYYY>.
+cd source/featured
+
+# mkdir <YYYY> # if not existing
+cd <YYYY>
+
+# Now, ready to start writing!
+
+# For instance, you can start by copying an old featured article:
+cp ../2012/csf.rst <my_shiny_new_featured_article.rst>
+
+# As all of the FEniCS web pages, these articles are written in the
+# reST (.rst) format. Google 'sphinx rst tutorial' if you are not
+# familiar with this format. Or if you are really lazy, just go here:
+# http://sphinx-doc.org/rest.html
+
+# <Write 2 - 3 paragraphs about your cool new feature>
+
+# Place your figures and images under ./source/featured/YYYY/images/
+# and refer to them using:
+# .. image:: images/my_really_pretty_plot.png
+
+# Build the web pages (don't worry, you will not break anything public)
+cd ../../../..
+make web
+
+# Look at the results
+firefox build/html/featured/<YYYY/my_shiny_new_featured_article.html> &
+
+# <Edit, make web and repeat until you are happy with the result>
+
+# <Make sure to commit your new files!>:
+git add source/featured/<YYYY/my_shiny_new_featured_article.rst>
+git add <your images>
+git commit -a
+
+# Find a nice image for the slider bar of the right size, namely
+# 366x282 and place it under
+# ./source/_static/images/featured/<YYYY/featured_item_xyz.png>
+git add ./source/_static/images/featured/<YYYY/featured_item_xyz.png>
+
+# Update the main index page by updating the list of slider items in
+# ./source/index.inc (Just copy and paste one of the other items and
+# update the references). And then commit it:
+git commit -a
+
+# Finally, make a pull request to FEniCS-web. Congratulations, mission
+# accomplished!
+
+# Alternatively, for FEniCS-web admins, do:
+make web
+make publish
+# Merge and push your changes

File instructions Deleted

  • Ignore whitespace
  • Hide word diff 
-###################################################################
-The complete guide to 'How to create a new FEniCS featured article'
-###################################################################
-
-# Get the FEniCS web source code:
-git clone git@bitbucket.org:fenics-project/fenics-web.git
-
-# Go there
-cd fenics-web
-
-# Checkout out your new featured article branch:
-git checkout -b user/featured-article-<xyz>
-
-# Read the README so that you have done that
-cat README.rst
-
-# The source for the featured articles is located under
-#  ./source/featured/<YYYY>.
-cd source/featured
-
-# mkdir <YYYY> # if not existing
-cd <YYYY>
-
-# Now, ready to start writing!
-
-# For instance, you can start by copying an old featured article:
-cp ../2012/csf.rst <my_shiny_new_featured_article.rst>
-
-# As all of the FEniCS web pages, these articles are written in the
-# reST (.rst) format. Google 'sphinx rst tutorial' if you are not
-# familiar with this format. Or if you are really lazy, just go here:
-# http://sphinx-doc.org/rest.html
-
-# <Write 2 - 3 paragraphs about your cool new feature>
-
-# Place your figures and images under ./source/featured/YYYY/images/
-# and refer to them using:
-# .. image:: images/my_really_pretty_plot.png
-
-# Build the web pages (don't worry, you will not break anything public)
-cd ../../../..
-make web
-
-# Look at the results
-firefox build/html/featured/<YYYY/my_shiny_new_featured_article.html> &
-
-# <Edit, make web and repeat until you are happy with the result>
-
-# <Make sure to commit your new files!>:
-git add source/featured/<YYYY/my_shiny_new_featured_article.rst>
-git add <your images>
-git commit -a
-
-# Find a nice image for the slider bar of the right size, namely
-# 366x282 and place it under
-# ./source/_static/images/featured/<YYYY/featured_item_xyz.png>
-git add ./source/_static/images/featured/<YYYY/featured_item_xyz.png>
-
-# Update the main index page by updating the list of slider items in
-# ./source/index.inc (Just copy and paste one of the other items and
-# update the references). And then commit it:
-git commit -a
-
-# Finally, make a pull request to FEniCS-web. Congratulations, mission
-# accomplished!
-
-# Alternatively, for FEniCS-web admins, do:
-make web
-make publish
-# Merge and push your changes
Updated by Marie Elisabeth Rognes
View revision

File instructions Modified

  • Ignore whitespace
  • Hide word diff 
+###################################################################
+The complete guide to 'How to create a new FEniCS featured article'
+###################################################################
+
+# Get the FEniCS web source code:
+git clone git@bitbucket.org:fenics-project/fenics-web.git
+
+# Go there
+cd fenics-web
+
+# Checkout out your new featured article branch:
+git checkout -b user/featured-article-<xyz>
+
+# Read the README so that you have done that
+cat README.rst
+
+# The source for the featured articles is located under
+#  ./source/featured/<YYYY>.
+cd source/featured
+
+# mkdir <YYYY> # if not existing
+cd <YYYY>
+
+# Now, ready to start writing!
+
+# For instance, you can start by copying an old featured article:
+cp ../2012/csf.rst <my_shiny_new_featured_article.rst>
+
+# As all of the FEniCS web pages, these articles are written in the
+# reST (.rst) format. Google 'sphinx rst tutorial' if you are not
+# familiar with this format. Or if you are really lazy, just go here:
+# http://sphinx-doc.org/rest.html
+
+# <Write 2 - 3 paragraphs about your cool new feature>
+
+# Place your figures and images under ./source/featured/YYYY/images/
+# and refer to them using:
+# .. image:: images/my_really_pretty_plot.png
+
+# Build the web pages (don't worry, you will not break anything public)
+cd ../../../..
+make web
+
+# Look at the results
+firefox build/html/featured/<YYYY/my_shiny_new_featured_article.html> &
+
+# <Edit, make web and repeat until you are happy with the result>
+
+# <Make sure to commit your new files!>:
+git add source/featured/<YYYY/my_shiny_new_featured_article.rst>
+git add <your images>
+git commit -a
+
+# Find a nice image for the slider bar of the right size, namely
+# 366x282 and place it under
+# ./source/_static/images/featured/<YYYY/featured_item_xyz.png>
+git add ./source/_static/images/featured/<YYYY/featured_item_xyz.png>
+
+# Update the main index page by updating the list of slider items in
+# ./source/index.inc (Just copy and paste one of the other items and
+# update the references). And then commit it:
+git commit -a
+
+# Finally, make a pull request to FEniCS-web. Congratulations, mission
+# accomplished!
+
+# Alternatively, for FEniCS-web admins, do:
+make web
+make publish
+# Merge and push your changes
Created by Marie Elisabeth Rognes
View revision

File instructions Added

  • Ignore whitespace
  • Hide word diff
Empty file added.
HTTPS SSH

You can clone a snippet to your computer for local editing. Learn more.