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.

Sign up for GitHub

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

Jump to bottom

[TSC]: Build with readthedocs #1753

Merged
merged 19 commits into from
Aug 13, 2020
Merged

[TSC]: Build with readthedocs #1753

merged 19 commits into from
Aug 13, 2020

Conversation

CsatariGergely
Copy link
Collaborator

This pr adds changes needed to build CNTT on readthedocs.org.
Please note that this is still work in progress.

Planned changes in this pr:

  • Move build specific files to a specific folder
  • Move the sphinx extensions to a separate folder

Planned changes in other pr-s needed to be fixed:

  • Table 5-7
  • Table A-1
  • Table 3-4
  • Link to ../../../_sources/ref_cert/RC2/chapters/chapter04.md.txt
  • Link to ../_sources/ref_model/README.md.txt
  • Link to ../_sources/ref_arch/abbreviations.md.txt
  • Link to ../../_sources/ven_impl/ven_template/README.md.txt
  • Link to ../../_sources/tech/release_notes/README.md.txt
  • Link to ../_sources/ref_model/abbreviations.md.txt
  • [9.5 CNTT Field Trial Approach] (Update chapter01.md #9.5)
  • gov/README.html ToC
  • RA1 Ch2 Rabiabdel patch 3 #53-consolidated-set-of-apis -> Update chapter10.md #5.3
  • RA1 Ch2 <!-- **Backlog of Req**<ol class="simple">
  • RA1 Ch4
  • RI1 Ch3.8
  • RI1 Ch5.4.1
  • RI1 Ch9.2.1
  • ven_impl/ven_template/

@CsatariGergely
Testing sphinx build
f8beef5 
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely
[RTD]: First try to build with custom extensions
7f07da6 
This change builds with Sphinx using two extensions:
  - direct-copy: to copy th eimage files directly from the source directory ot the target
  - readme-to-index: to copy the generated README.html-s to index.html also

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely
Correcging relative links
0908528 
This change adds and utilises a sphinx extension to support the
relative links when transforming from .md to .html

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely
Correcting the corrector
0085fd2
@CsatariGergely
Getting rid of strange filenames
4e66021
@CsatariGergely
Skipping strange path-s
bd23e63
@CsatariGergely
Skipping nonexisting uri-s
8504671
@CsatariGergely
Skipping nonexisting uri-s
1e48766
@CsatariGergely
Merge branch 'master' into rtd-sphinx
d0621ad
@CsatariGergely CsatariGergely added the WIP Work in progress label Jul 6, 2020
@CsatariGergely CsatariGergely changed the title [GOV?]: Build with readthedocs [TSC]: Build with readthedocs Jul 8, 2020
@CsatariGergely
[TSC]: Adding rtd_sphinx_theme to the local build
5755627 
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely
Merge branch 'master' into rtd-sphinx
f139c53 
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely
[rtd]: Adding common chapter to the index
96150b9 
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely
[RA1 Ch2]: Correction of comments
8207eec 
Comment synthax was problematic for sphonx tranlation.

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely
[RA1 Ch4]: Fix br-s
ea4a384 
</br>-s were changed to <br> as they were confusing sphinx.

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely
[RI1 Ch3]: Formatting changes to the table in 3.8
6b1c1b3 
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@rabi-abdel
Copy link
Collaborator

@CsatariGergely let me know once you need this to be merged.

@CsatariGergely
Merge branch 'master' into rtd-sphinx
ce8e69d
@CsatariGergely
Move sphinx extensions to a folder
40bb6a0 
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely CsatariGergely removed the WIP Work in progress label Jul 29, 2020
@CsatariGergely
Adding copyright notices to the Sphinx extensions
b0ee96c 
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@bfcohen
Copy link
Collaborator

bfcohen commented Jul 30, 2020

Looks great! Much needed.

bfcohen
bfcohen approved these changes Jul 30, 2020
View reviewed changes
Copy link
Collaborator

@bfcohen bfcohen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much needed! Thank youl.

@CsatariGergely @pgoyal01
[RI1 Ch4]: Correctionof review comments
6d09ba5 
Co-authored-by: Pankaj Goyal <52107136+pgoyal01@users.noreply.github.com>
@scottsteinbrueck scottsteinbrueck merged commit 20adcce into anuket-project:master Aug 13, 2020
@CsatariGergely
Copy link
Collaborator Author

Thanks. Here is the first build: https://cntt.readthedocs.io/en/latest/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pgoyal01 pgoyal01 pgoyal01 approved these changes

@bfcohen bfcohen bfcohen approved these changes

@ulikleber ulikleber ulikleber approved these changes

@rabiabdel rabiabdel Awaiting requested review from rabiabdel

@jayacha jayacha Awaiting requested review from jayacha

@scottsteinbrueck scottsteinbrueck Awaiting requested review from scottsteinbrueck

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@CsatariGergely @rabi-abdel @bfcohen @pgoyal01 @ulikleber @scottsteinbrueck