Skip to content

Commit

Permalink
changed HIPE directory to reflect new number
Browse files Browse the repository at this point in the history
Signed-off-by: michael <michael.boyd@sovrin.org>
  • Loading branch information
michaeldboyd committed Dec 6, 2018
1 parent b546db0 commit d2da78a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Indy Docs Framwork
- Name: indy-docs-framework
- Author: Michael Boyd <michael.boyd@sovrin.org>
- Start Date: 11/27/18
Expand All @@ -24,7 +25,6 @@ We've created a proof of concept with five of the Indy repositories at the above
* It is flexible to future changes in our software architecture and repository structure.

## Tutorial
# Indy Documentation Framework
[tutorial]: #tutorial

### Relevant Repositories
Expand Down Expand Up @@ -136,7 +136,7 @@ Here are the quick steps to achieve this on a local machine without depending on
pip install Sphinx
pip install sphinx_rtd_theme
pip install recommonmark==0.4.0
cd docs/source # Be in this directory. Makefile sits there.
cd docs/source ## Be in this directory. Makefile sits there.
make html
```

Expand All @@ -153,11 +153,11 @@ While readthedocs supports subprojects, it does not automatically make a shared
To make sure that each project includes the global sidebar on readthedocs, each repo's conf.py file has a couple lines to import the remote_conf.py file from github and build the sidebar during the sphinx build.

```python
# conf.py
## conf.py
...
# ------------ Remote Documentation Builder Config -----------
# Note: this is a slightly hacky way of maintaining a consistent sidebar amongst all the repositories.
# Do you have a better way to do it?
## ------------ Remote Documentation Builder Config -----------
## Note: this is a slightly hacky way of maintaining a consistent sidebar amongst all the repositories.
## Do you have a better way to do it?
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if(on_rtd):
rtd_version = os.environ.get('READTHEDOCS_VERSION', 'latest')
Expand Down

0 comments on commit d2da78a

Please sign in to comment.