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

sphinx: multi-language module names should be after readme #185

Closed
eladb opened this issue Aug 16, 2018 · 0 comments
Closed

sphinx: multi-language module names should be after readme #185

eladb opened this issue Aug 16, 2018 · 0 comments

Comments

@eladb
Copy link
Contributor

eladb commented Aug 16, 2018

The current structure of a generated sphinx doc is:

H1 <name>
<module names tabs>
<readme> (usually begins with an H2)
H2 Reference
<reference>

I think the readme should be before the module names (these are effectively part of the reference section):

H1 <name>
<readme> (usually begins with an H2)
H2 Reference
<module names tabs>
<reference>
eladb pushed a commit that referenced this issue Sep 17, 2018
Sphinx improvements
dc00c8f 
* Fix #228: allow readme file to define sphinx topic header
* Fix #185: move multi-language tabs after readme
* Update README
@eladb eladb mentioned this issue Sep 17, 2018
Merged
eladb pushed a commit that referenced this issue Sep 17, 2018
feat(sphinx): allow readme file to define sphinx header and reorganiz…
405da9c 
…e topic (#229)

* Fix #228: allow readme file to define sphinx topic header
* Fix #185: move multi-language tabs after readme
* Update README
eladb pushed a commit that referenced this issue Sep 20, 2018
v0.7.6 (#239)
04cb6bb 
Bug Fixes
======================
 * Sphinx generated incorrect type references for display ([#232](#232)) ([b664805](b664805))
* **jsii:** Defaulted parameters were not rendered as optional ([#234](#234)) ([578bf9c](578bf9c)), closes [#233](#233)
* **jsii:** Don't skip emit on TS errors when in "watch" mode ([#236](#236)) ([30d1491](30d1491)), closes [#235](#235)
* **jsii:** Optional `any` represented as required ([#237](#237)) ([91074f3](91074f3)), closes [#230](#230)

Features
======================
 * **sphinx:** allow readme file to define sphinx header and reorganize topic ([#229](#229)) ([405da9c](405da9c)), closes [#228](#228) [#185](#185)
* Document overriden/inherited members ([#238](#238)) ([7a6278a](7a6278a)), closes [#196](#196)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@eladb