@foo-bar-baz-qux

Signed up since Aug. 8, 2017

Points

Timestamp Points Contributor Ad-hoc References
Sept. 21, 2017 3 @foo-bar-baz-qux No Issues #90
PR #129
Aug. 23, 2017 5 @foo-bar-baz-qux No Issues #46
PR #48
Aug. 10, 2017 3 @foo-bar-baz-qux No Issues #47
PR #49

Activity

@foo-bar-baz-qux opened a new pull request: #129: Fix documentation compilation

<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> Turned out to be pretty finicky to fix, Sphinx (apidoc) and Django can be a pain to get working together. Changes made: - Re-add the two Docker images (`compile_docs` and `documentation`). I've setup a new Docker file for both of these images that uses the requirements from the interface and prediction modules as well as the documentation-specific requirement file. - Add some required additional environment variables to allow Django to at least be importable for Sphinx's apidoc. I re-use the `compose/interface/entrypoint.sh` file from the `interface` module to setup the `DATABASE_URL` env variable that's required for django, before running the Sphinx makefile. Currently a blank string works for the URL, but I'm future-proofing in case a real URL becomes necessary for Sphinx in the future. - Fix some minor formatting issues in the docstrings which were throwing some warnings - Remove the references to `backend.static` but leave the module in as the folder still appears to be in the `master` branch. ## Reference to official issue <!--- If fixing a bug, there should be an existing issue describing it with steps to reproduce --> <!--- Please link to the issue here: --> Fixes #90. ## Motivation and Context <!--- Why is this change required? What problem does it solve? --> <!--- If adding a new feature or making improvements not already reflected in an official issue, please reference the relevant sections of the design doc --> Fix documentation compilation. ## How Has This Been Tested? <!--- Please describe in detail how you tested your changes. --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> I've run the compilation commands in the original issue and also run the whole Docker stack. It seems to compile and serve the documentation at `http://localhost:8002` without issue. Some Sphinx warnings remain regarding unreferenced MD files that I'm assuming will be used later. ## Screenshots (if appropriate): ## CLA - [x] I have signed the CLA; if other committers are in the commit history, they have signed the CLA as well
1 year, 2 months ago
1 year, 4 months ago
1 year, 4 months ago

@foo-bar-baz-qux opened a new pull request: #49: Fix heading links in 'Jobs to be done' documentation page

<!--- Provide a general summary of your changes in the Title above --> ## Description Changed headings on the "Jobs to be done" documentation page so that the heading links do not collide. Heading links are generated from the text of the headings, so having the same heading text on the same page causes issues. This seems to be the simplest solution. I initially tried looking for other solutions, like `:ref:`, but the markdown to RST parser generates links automatically from the text with no obvious way to override. Since the TOC is auto-generated using these heading links, it also becomes an issue when trying to link from the navigation pane to any `:ref` links on the page. Could manually create the TOC and navigation but would be tedious to update in the future. Also tried enabling `autostructify` and trying to use the references in native RST embedded using `eval_rst` code blocks along with the section titles, but the section titles seem to cause confusion for the parser. ## Reference to official issue <!--- If fixing a bug, there should be an existing issue describing it with steps to reproduce --> <!--- Please link to the issue here: --> Fixes #47. ## Motivation and Context <!--- Why is this change required? What problem does it solve? --> <!--- If adding a new feature or making improvements not already reflected in an official issue, please reference the relevant sections of the design doc --> Allows independent heading links on the "Jobs to be done" documentation page. ## How Has This Been Tested? <!--- Please describe in detail how you tested your changes. --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> Built the sphinx documentation locally and made sure the links updated and worked. ## Screenshots (if appropriate): ## CLA - [X ] I have signed the CLA; if other committers are in the commit history, they have signed the CLA as well
1 year, 4 months ago

@foo-bar-baz-qux opened a new pull request: #48: Fix incorrect developer documentation link in the README

<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> Changed link to point to Docker setup instructions, added another link to the main developer documentation page. ## Reference to official issue <!--- If fixing a bug, there should be an existing issue describing it with steps to reproduce --> <!--- Please link to the issue here: --> Fixes #46. ## Motivation and Context <!--- Why is this change required? What problem does it solve? --> <!--- If adding a new feature or making improvements not already reflected in an official issue, please reference the relevant sections of the design doc --> Documentation fix. ## How Has This Been Tested? <!--- Please describe in detail how you tested your changes. --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> Tested the new links on the rendered MD page. ## Screenshots (if appropriate): ## CLA - [X] I have signed the CLA; if other committers are in the commit history, they have signed the CLA as well
1 year, 4 months ago