Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build from top-level project #52

Closed
jputrino opened this issue Oct 13, 2016 · 4 comments
Closed

Build from top-level project #52

jputrino opened this issue Oct 13, 2016 · 4 comments
Labels

Comments

@jputrino
Copy link
Contributor

jputrino commented Oct 13, 2016

Description

@bmarshall13 has a makefile that lets him build from the top-level project (this one) when writing docs for a subproject (lightweight-proxy).
We need to leverage this to identify and correct issues that would not occur when building docs locally from a subproject (e.g., not finding the _static directory or knowing where to find included files).

  • investigate variablizing paths to make it easier to specify where files can be found
@bmarshall13
Copy link
Contributor

I'm not sure if this is an issue or not.

I am building this repo with make html while in f5-ci-docs/docs

The paths are these:

  1. f5-ci-docs/docs/f5-fpp/README.rst
  2. f5-ci-docs/docs/f5-fpp/_includes/topic_kubernetes-notes.rst
  3. f5-ci-docs/docs/f5-fpp/_static/example-service-flowpoint.yaml

1 contains .. include:: _includes/topic_kubernetes-notes.rst referencing 2
2 contains .. literalinclude:: _static/example-service-flowpoint.yaml referencing 3

1 correctly renders the content in 3, which is suprising. It shows that the relative root of the literalinclude is that of 1, and not 2 where the statement exists.

The problem here is that I can only include that content from a specific directory. To prove this to myself, I also include 2 from f5-ci-docs/docs/index.rst. That doesn't render correctly.

However,

@bmarshall13
Copy link
Contributor

The docs say that the path should be relative to the file doing the importing, but this doesn't appear to be the case.

http://www.sphinx-doc.org/en/stable/markup/code.html#includes

@jputrino
Copy link
Contributor Author

added to lightweight-proxy; see project Makefile.

@jputrino
Copy link
Contributor Author

rST epilog needs to be controlled from f5-ci-docs to ensure consistency and easy updating across all docs.

jputrino added a commit that referenced this issue Oct 24, 2016
Problem: Because all of the documentation lives in many different project repos, all content is pushed here automatically from the source. We need to be able to build the docs from the top-down (i.e., from this repo) without anything breaking. Also, the content from the mesos/marathon beta release needs to be refactored to meet the current content strategy.

Analysis:
I set up the docs/includes directory to receive content from the individual projects by creating the necessary, and correctly-named, directories (f5-csc_m, f5-csc_k, f5-lwp, f5-lwpc).
I also removed all of the content that was from the beta release (after copying it into the correct project repo to ensure no content was inadvertently lost).
I removed all previous project dirs from the docs/ directory.
The 'html_static_path' and rst_epilog in docs/conf.py have been updated.

Unit/Robot tests:
n/a - not yet configured

remove doc artifacts from beta release; remove docs/f5-lwp (has been relocated to docs/includes
@jputrino jputrino mentioned this issue Oct 24, 2016
jputrino added a commit that referenced this issue Oct 24, 2016
Problem: Because all of the documentation lives in many different project repos, all content is pushed here automatically from the source. We need to be able to build the docs from the top-down (i.e., from this repo) without anything breaking. Also, the content from the mesos/marathon beta release needs to be refactored to meet the current content strategy.

Analysis:
I set up the docs/includes directory to receive content from the individual projects by creating the necessary, and correctly-named, directories (f5-csc_m, f5-csc_k, f5-lwp, f5-lwpc).
I also removed all of the content that was from the beta release (after copying it into the correct project repo to ensure no content was inadvertently lost).
I removed all previous project dirs from the docs/ directory.
The 'html_static_path' and rst_epilog in docs/conf.py have been updated.

Unit/Robot tests:
n/a - not yet configured

remove doc artifacts from beta release; remove docs/f5-lwp (has been relocated to docs/includes
@jputrino jputrino closed this as completed Nov 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants