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

New documentation structure #482

Merged
merged 39 commits into from
Dec 10, 2017
Merged

New documentation structure #482

merged 39 commits into from
Dec 10, 2017

Conversation

eine
Copy link
Collaborator

@eine eine commented Dec 9, 2017 •
edited
Loading

Close #280.

This PR:

Docker integration is removed as of august. Integrating it again and the addition of longer tutorials are discussed in #477.

This is the current master: http://ghdl.readthedocs.io/en/latest/index.html
This is the current new-documentation-structure: http://ghdl.readthedocs.io/en/new-documentation-structure/
This is the proposed merge: http://ghdl-devfork.readthedocs.io/en/new-documentation-structure/

Patrick Lehmann and others added 30 commits December 9, 2017 17:58
New documentation structure for GHDL.
0a3eb3b
Fixed used theme to allow local building.
a2c1891
Added Python (PIP) requirements file. Request Sphinx >= 1.5.2.
fe64bb1
Added a YAML file to configure ReadTheDocs.
c7a149e
Moved introduction text.
2cbe97b
Moving old content to new structure
8d85db6
File extensions must be rst, not rst.txt
2bb8f24
Removed numbers from folder names.
942f84c
Add dots to TODOs
c7e9199
Fix changelog
72a677c
Remove <topic> from TODOs
4231a58
Move split ols txts to doc/oldmds. Add shields to README. Change targ…
0c35597 
…et of license shield on RTD.
Update README.md with shield, pros/cons table...
dd76233
Allow markdown
d2dec7a 
Last files from oldmds removed. All the content is in the new structure now. COPYING replaced with the md version.

Update NEWS.md
README.md, index, WhatIsVHDL, WhatIsGHDL ready for review.
18b0571 
Add shortcuts for shields in a single file and include it where used.
Create base64 GitHub and Travis-CI logos with b64.io and add them to self-created shields. Replace gitter with shield.io's variant.
Start rewriting <Contributing>
Add theme_overrrides.css
3f34d95 
Move WhatIs* to About. Move About, Contributing and Copying to doc. Rename Copying to License. Append CC-BY-SA-4.0 legalcode to COPYING.md
Chapter Introduction ready for review.
Starting to rewrite Building
Remove scrollbar in small screens
52a1774 
Fix gitter shield link
Fix first example of QuickStartGuide
Files in the root not capitalized.
00d4a8c 
Second chapter ready for first review:
Invoking reordered, some content moved to Command Reference, information compacted, command shortcuts added to titles. Known features which are missing in the doc added to TODOs or to Roadmap.
Add export subsections to Using/Simulation
Directory structure described in Building
Meta.rst added to changelog
06fac7b
Describe commands as options. Fix internal refs to options. Apply
6b5f15a 
suggestions about ch 2. Add options given by the executable but not
documented earlier.
Add reference issues for docker
499c25d
Remove duplicated option
e9c2062
Add raw sources of tutorial 'How to simulate an UART VHDL code with g…
42a0e3e 
…hdl}' by 'René Doß'
Fixed headlines (1).
aac024e
Added requirement.
ad681e8
Fixed typos, indentation and headline underlining.
3726f55
Read rst_prolog content from an external file.
cf917f1
PrecompileVendorPrimitives: Translated lots of Markdown to Restructur…
ed014d1 
…edText syntax.
Restructured build section. Created smaller files. Created (hidden) s…
4a17f95 
…ub-ToCs. Added out-dated build instructions for Windows GNAT GPL flow from private README.md.
Fixed more syntax problems.
0e1e40e
This was referenced Dec 9, 2017
Closed
Closed
@tgingold tgingold merged commit 8e06c39 into ghdl:master Dec 10, 2017
@eine eine deleted the new-documentation-structure branch December 10, 2017 17:08
@eine eine mentioned this pull request Dec 22, 2017
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
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
2 participants
@eine @tgingold