-
Notifications
You must be signed in to change notification settings - Fork 90
Updating the wiki
-
The Albany wiki can be updated directly in the wiki interface, using the New Page and Edit Page buttons.
-
The wiki can also be updated by cloning it using git. To do this, first clone the wiki repo:
git clone [email protected]:gahansen/Albany.wiki.git
-
Make your edits, commit the changes, and push the changes just like the main repository.
-
The web pages exist on a separate branch called gh-pages inside the main Albany repo. To do this, first clone a copy of the main repo if you do not have one handy:
git clone [email protected]:gahansen/Albany.git
-
Next, checkout the gh-pages branch:
git checkout -b gh-pages origin/gh-pages
-
Make your edits, commit the changes, and push the changes just like the main repository.
-
To directly push to the gh-pages branch on github:
git push origin gh-pages
-
The Doxygen pages on the website do not automatically update when the source in the main repo changes. Thus, time-to-time one needs to refresh the content on the website.
-
If you have doxygen installed, CMake will automatically create the doc target for make during a typical Albany configure step. To generate the doxygen pages, in the build directory type
make doc
-
Recursively copy the contents of the html directory into the
doxygen/html
directory of the gh-pages branch. Then commit and push these changes to update the content of the doxygen pages on the website.
-
Please update the html pages in the main repo at
/doc/user-guide
-
gahansen will move these changes to the website manually occasionally. This will soon be replaced with a subtree merge.
-
Note: Please do not modify the html pages in the gh-pages, these changes will be erased when the contents of the main repo are copied to the gh-pages branch.